metior 0.1.1

data/lib/metior/version.rb

@@ -0,0 +1,11 @@
+# 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
+
+  # The current version of the Metior gem
+  VERSION = '0.1.1'
+
+end

data/metior.gemspec

@@ -0,0 +1,26 @@
+require 'bundler'
+
+require File.expand_path(File.dirname(__FILE__) + '/lib/metior/version')
+
+Gem::Specification.new do |s|
+  s.name        = "metior"
+  s.version     = Metior::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Sebastian Staudt' ]
+  s.email       = [ 'koraktor@gmail.com' ]
+  s.homepage    = 'http://koraktor.de/metior'
+  s.summary     = 'A source code history analyzer API'
+  s.description = 'Metior is a source code history analyzer that provides various statistics about a source code repository and its change over time.'
+
+  Bundler.definition.dependencies.each do |dep|
+    if dep.groups.include?(:development) || dep.groups.include?(:test)
+      s.add_development_dependency(dep.name, dep.requirement.to_s)
+    else
+      s.add_dependency(dep.name, dep.requirement.to_s)
+    end
+  end
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- test/*`.split("\n")
+  s.require_paths      = [ 'lib' ]
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+# 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
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'metior'
+include Metior
+
+Bundler.require :test
+
+# Extends TestCase functionality
+class Test::Unit::TestCase
+
+  # Provides a negative assertion that's easier on the eyes
+  #
+  # The assertion fails, if the given value is +true+.
+  #
+  # @param [true, false] boolean The value that should be +false+
+  # @param [String] message The message that should be displayed
+  def assert_not(boolean, message = '')
+    assert !boolean, message
+  end
+
+end

data/test/mock_vcs/actor.rb

@@ -0,0 +1,28 @@
+# 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 MockVCS
+
+    class Actor < Metior::Actor
+
+      def self.id_for(actor)
+        actor.last
+      end
+
+      def initialize(repo, actor)
+        super repo
+
+        @id   = actor.last
+        @name = actor.first
+      end
+    end
+
+  end
+
+end

data/test/mock_vcs/commit.rb

@@ -0,0 +1,53 @@
+# 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 'mock_vcs/actor'
+require 'metior/commit'
+
+module Metior
+
+  module MockVCS
+
+    class Commit < Metior::Commit
+
+      def initialize(repo, range, commit)
+        super repo, range
+
+        @additions      = commit[:impact].first.to_i
+        @authored_date  = Time.at commit[:info][6].to_i
+        @committed_date = Time.at commit[:info][3].to_i
+        @deletions      = commit[:impact].last.to_i
+        @id             = commit[:ids].first
+        @message        = commit[:info].first
+
+        authors = repo.authors range
+        @author = authors[Actor.id_for commit[:info][4..5]]
+        @author = Actor.new repo, commit[:info][4..5] if author.nil?
+        @author.add_commit self
+
+        committers = repo.committers range
+        @committer = committers[Actor.id_for commit[:info][1..2]]
+        @committer = Actor.new repo, commit[:info][1..2] if @committer.nil?
+        @committer.add_commit self
+
+        @added_files    = []
+        @modified_files = []
+        @deleted_files  = []
+        commit[:files].each do |file|
+          if file.first == 'A'
+            @added_files    << file.last
+          elsif file.first == 'A'
+            @deleted_files  << file.last
+          else
+            @modified_files << file.last
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/mock_vcs/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 'metior/repository'
+require 'mock_vcs/commit'
+
+module Metior
+
+  module MockVCS
+
+    NAME = :mock
+
+    include VCS
+
+    class Repository < Metior::Repository
+
+      DEFAULT_BRANCH = 'master'
+
+      include Metior::MockVCS
+
+      def initialize(path)
+        super path
+
+        @file = File.open(File.expand_path(path), 'r')
+        @file.set_encoding 'utf-8' if @file.respond_to? :set_encoding
+      end
+
+      def load_commits(range)
+        commits = []
+
+        commit = {}
+        @file.lines.each do |line|
+          line.strip!
+
+          next if line.empty?
+
+          if line.match /^[AMD]\0/
+            commit[:files] = [] unless commit.key? :files
+            commit[:files] << line.split("\0")
+          elsif line.match /\d+\0\d+$/
+            commit[:impact] = line.split("\0")
+
+            if commits.empty?
+              if range.first != '' && !commit[:ids].include?(range.last)
+                commit = {}
+                next
+              end
+            elsif commit[:ids].include? range.first
+              break
+            end
+
+            commits << commit
+            commit = {}
+          else
+            line = line.split("\0")
+            ids = [line[0]]
+            ids += line[1][2..-2].split(', ') unless line[1].empty?
+            commit[:ids]  = ids
+            commit[:info] = line[2..-1]
+          end
+        end
+
+        commits
+      end
+
+    end
+
+  end
+
+end

data/test/test_class_loading.rb

@@ -0,0 +1,61 @@
+# 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 'helper'
+
+class TestClassLoading < Test::Unit::TestCase
+
+  context 'Metior' do
+
+    should 'load basic modules and dependencies first' do
+      assert Object.const_defined? :Metior
+      assert Metior.const_defined? :Git
+      assert Metior.const_defined? :GitHub
+      assert Metior.const_defined? :VCS
+      assert Metior.const_defined? :VERSION
+
+      assert !Metior.const_defined?(:Actor)
+      assert !Metior.const_defined?(:Commit)
+      assert !Metior.const_defined?(:Repository)
+      assert !Metior::Git.const_defined?(:Actor)
+      assert !Metior::Git.const_defined?(:Commit)
+      assert !Metior::Git.const_defined?(:Repository)
+      assert !Metior::GitHub.const_defined?(:Actor)
+      assert !Metior::GitHub.const_defined?(:Commit)
+      assert !Metior::GitHub.const_defined?(:Repository)
+
+      assert !Object.const_defined?(:Grit)
+      assert !Object.const_defined?(:Octokit)
+    end
+
+    should 'load requirements when using Git' do
+      Metior::Git::Repository
+
+      assert Metior.const_defined? :Actor
+      assert Metior.const_defined? :Commit
+      assert Metior.const_defined? :Repository
+      assert Metior::Git.const_defined? :Actor
+      assert Metior::Git.const_defined? :Commit
+      assert Metior::Git.const_defined? :Repository
+
+      assert Object.const_defined? :Grit
+    end
+
+    should 'load requirements when using GitHub' do
+      Metior::GitHub::Repository
+
+      assert Metior.const_defined? :Actor
+      assert Metior.const_defined? :Commit
+      assert Metior.const_defined? :Repository
+      assert Metior::GitHub.const_defined? :Actor
+      assert Metior::GitHub.const_defined? :Commit
+      assert Metior::GitHub.const_defined? :Repository
+
+      assert Object.const_defined? :Octokit
+    end
+
+  end
+
+end

data/test/test_git.rb

@@ -0,0 +1,22 @@
+# 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 'helper'
+
+class TestGit < Test::Unit::TestCase
+
+  context 'The Git implementation' do
+
+    should 'support file stats' do
+      assert Metior::Git.supports? :file_stats
+    end
+
+    should 'support line stats' do
+      assert Metior::Git.supports? :line_stats
+    end
+
+  end
+
+end

data/test/test_github.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 'helper'
+
+class TestGitHub < Test::Unit::TestCase
+
+  context 'The GitHub implementation' do
+
+    should 'not support file stats' do
+      assert_not Metior::GitHub.supports? :file_stats
+    end
+
+    should 'not support line stats' do
+      assert_not Metior::GitHub.supports? :line_stats
+    end
+
+    should 'not be able to get file stats of a repository' do
+      repo = Metior::GitHub::Repository.new 'koraktor', 'rubikon'
+      assert_raises UnsupportedError do
+        repo.file_stats
+      end
+    end
+
+    should 'not be able to get the most significant authors of a repository' do
+      repo = Metior::GitHub::Repository.new 'koraktor', 'rubikon'
+      assert_raises UnsupportedError do
+        repo.significant_authors
+      end
+    end
+
+    should 'not be able to get the most significant commits of a repository' do
+      repo = Metior::GitHub::Repository.new 'koraktor', 'rubikon'
+      assert_raises UnsupportedError do
+        repo.significant_commits
+      end
+    end
+
+  end
+
+end

data/test/test_metior.rb

@@ -0,0 +1,34 @@
+# 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 'helper'
+
+class TestMetior < Test::Unit::TestCase
+
+  context 'Metior' do
+
+    should 'should provide several VCS implementations' do
+      assert_equal({ :git => Git, :github => GitHub }, Metior.vcs_types)
+      assert_equal Git, Metior.vcs(:git)
+    end
+
+    should 'raise an error if an implementation does not exist' do
+      begin
+        Metior.vcs :unknown
+        assert false
+      rescue
+        assert $!.is_a? RuntimeError
+        assert_equal 'No VCS registered for :unknown', $!.message
+      end
+    end
+
+    should 'allow easy creation of a implementation specific repository' do
+      assert_kind_of Git::Repository, Metior.repository(:git, File.dirname(File.dirname(__FILE__)))
+      assert_kind_of GitHub::Repository, Metior.repository(:github, 'some', 'user')
+    end
+
+  end
+
+end

data/test/test_repository.rb

@@ -0,0 +1,150 @@
+# 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 'helper'
+
+class TestRepository < Test::Unit::TestCase
+
+  context 'The base class for Metior VCS repositories' do
+
+    setup do
+      require 'metior/repository'
+
+      @repo = Metior::Repository.new('dummy')
+    end
+
+    should 'not implement the #load_commits method' do
+      assert_raise NotImplementedError do
+        @repo.send(:load_commits, nil)
+      end
+    end
+
+    should 'parse commit ranges correctly' do
+      assert_equal 'master'..'development', @repo.send(:parse_range, 'master'..'development')
+      assert_equal 'master'..'development', @repo.send(:parse_range, 'master..development')
+      assert_equal ''..'master', @repo.send(:parse_range, 'master')
+    end
+
+    should 'hit the cache when loading the same commit range' do
+      @repo.expects(:load_commits).once.returns([])
+
+      @repo.commits 'master'
+      @repo.commits 'master'
+    end
+
+    should 'miss the cache when loading a different commit range' do
+      @repo.expects(:load_commits).twice.returns([])
+
+      @repo.commits 'master'
+      @repo.commits 'HEAD'
+    end
+
+  end
+
+  context 'A repository implementation' do
+
+    setup do
+      require 'mock_vcs/repository'
+
+      repo_file = "#{File.dirname(__FILE__)}/fixtures/mojombo-grit-master-1b2fe77.txt"
+      @repo = MockVCS::Repository.new repo_file
+    end
+
+    should 'be able to load all commits from the repository' do
+      commits = @repo.commits
+      assert_equal 415, commits.size
+      assert commits.all? { |commit| commit.is_a? Metior::Commit }
+
+      head = commits.first
+      assert_equal '4c592b4', head.id
+    end
+
+    should 'be able to load a range of commits from the repository' do
+      commits = @repo.commits 'ef2870b'..'4c592b4'
+      assert_equal 5, commits.size
+      assert commits.all? { |commit| commit.is_a? Metior::Commit }
+      assert_equal '4c592b4', commits.first.id
+      assert_equal 'f0cc7f7', commits.last.id
+    end
+
+    should 'know the authors of the repository' do
+      authors = @repo.authors
+      assert_equal 37, authors.size
+      assert authors.values.all? { |author| author.is_a? Metior::Actor }
+
+      assert_equal %w{
+        adam@therealadam.com aman@tmm1.net antonin@hildebrand.cz
+        bobbywilson0@gmail.com bryce@worldmedia.net cehoffman@gmail.com
+        chapados@sciencegeeks.org cho45@lowreal.net chris@ozmm.org
+        davetron5000@gmail.com david.kowis@rackspace.com dustin@spy.net
+        engel@engel.uk.to evil@che.lu gram.gibson@uky.edu
+        hiroshi3110@gmail.com igor@wiedler.ch johan@johansorensen.com
+        jos@catnook.com jpriddle@nevercraft.net kamal.fariz@gmail.com
+        koraktor@gmail.com mtraverso@acm.org ohnobinki@ohnopublishing.net
+        paul+git@mjr.org pjhyett@gmail.com rsanheim@gmail.com
+        rtomayko@gmail.com schacon@gmail.com scott@railsnewbie.com
+        technoweenie@gmail.com tim@dysinger.net tim@spork.in
+        tom@mojombo.com tom@taco.(none) voker57@gmail.com wayne@larsen.st
+      }, authors.keys.sort
+    end
+
+    should 'know the committers of the repository' do
+      committers = @repo.committers
+      assert_equal 29, committers.size
+      assert committers.values.all? { |committer| committer.is_a? Metior::Actor }
+
+      assert_equal %w{
+         adam@therealadam.com aman@tmm1.net antonin@hildebrand.cz
+         bobbywilson0@gmail.com bryce@worldmedia.net chris@ozmm.org
+         davetron5000@gmail.com david.kowis@rackspace.com dustin@spy.net
+         engel@engel.uk.to evil@che.lu hiroshi3110@gmail.com
+         johan@johansorensen.com jos@catnook.com kamal.fariz@gmail.com
+         koraktor@gmail.com mtraverso@acm.org ohnobinki@ohnopublishing.net
+         paul+git@mjr.org pjhyett@gmail.com rsanheim@gmail.com
+         rtomayko@gmail.com schacon@gmail.com technoweenie@gmail.com
+         tim@dysinger.net tim@spork.in tom@mojombo.com tom@taco.(none)
+         voker57@gmail.com
+      }, committers.keys.sort
+    end
+
+    should 'know the most significant authors of the repository' do
+      authors = @repo.significant_authors
+      assert_equal 3, authors.size
+      assert authors.all? { |author| author.is_a? Metior::Actor }
+
+      assert_equal [
+        "tom@mojombo.com", "schacon@gmail.com", "rtomayko@gmail.com"
+      ], authors.collect { |author| author.id }
+    end
+
+    should 'know the most significant commits of the repository' do
+      commits = @repo.significant_commits('master', 8)
+      assert_equal 8, commits.size
+      assert commits.all? { |commit| commit.is_a? Metior::Commit }
+
+      assert_equal %w{
+        c0f0b4f 47ab25c f3a24ae 18ec70e 242253b c87612b 6bb41e4 4d9c7be
+      }, commits.collect { |commit| commit.id }
+
+      modifications = commits.first.modifications
+      commits[1..-1].each do |commit|
+        assert modifications >= commit.modifications
+        modifications = commit.modifications
+      end
+    end
+
+    should 'know the top authors of the repository' do
+      authors = @repo.top_authors
+      assert_equal 3, authors.size
+      assert authors.all? { |author| author.is_a? Metior::Actor }
+
+      assert_equal [
+        "tom@mojombo.com", "schacon@gmail.com", "technoweenie@gmail.com"
+      ], authors.collect { |author| author.id }
+    end
+
+  end
+
+end