metior 0.1.4 → 0.2.0

data/test/test_git.rb

@@ -25,8 +25,7 @@ class TestGit < Test::Unit::TestCase
     setup do
       @repo = Metior::Git::Repository.new File.dirname(File.dirname(__FILE__))
       @@grit_commits ||= Fixtures.commits_as_grit_commits(''..'master')
-      @commits_stub = Grit::Repo.any_instance.stubs :commits
-      @commits_stub.returns @@grit_commits
+      Grit::Repo.any_instance.stubs(:commits).returns @@grit_commits.values
     end
 
     should 'be able to load all commits from the repository\'s default branch' do
@@ -39,9 +38,11 @@ class TestGit < Test::Unit::TestCase
     end
 
     should 'be able to load a range of commits from the repository' do
-      @commits_stub = Grit::Repo.any_instance.stubs :commits
-      api_response = Fixtures.commits_as_grit_commits('ef2870b'..'4c592b4')
-      @commits_stub.returns api_response
+      api_response = Fixtures.commits_as_grit_commits('ef2870b'..'4c592b4').values
+      Grit::Repo.any_instance.stubs(:commits).once.returns(api_response)
+
+      @repo.expects(:id_for_ref).with('ef2870b').once.returns('ef2870b')
+      @repo.expects(:id_for_ref).with('4c592b4').once.returns('4c592b4')
 
       commits = @repo.commits 'ef2870b'..'4c592b4'
       assert_equal 6, commits.size
@@ -101,6 +102,9 @@ class TestGit < Test::Unit::TestCase
     end
 
     should 'provide easy access to simple repository statistics' do
+      Metior::Git::Repository.any_instance.expects(:id_for_ref).twice.
+        with('master').returns('1b2fe77')
+
       stats = Metior.simple_stats :git, File.dirname(File.dirname(__FILE__))
 
       assert_equal 157, stats[:active_days].size
@@ -111,6 +115,55 @@ class TestGit < Test::Unit::TestCase
       assert_equal 5, stats[:top_contributors].size
     end
 
+    should 'be able to load all the branches of a repository' do
+      branches = {
+        'master' => '1b2fe77',
+        'branch1' => '1234567',
+        'branch2' => '0abcdef'
+      }
+      grit_branches = branches.map do |branch|
+        commit = Grit::Commit.new(nil, branch.last, [], nil, nil, nil, nil, nil, [])
+        Grit::Head.new branch.first, commit
+      end
+      Grit::Repo.any_instance.expects(:branches).once.returns(grit_branches)
+
+      assert_equal %w{branch1 branch2 master}, @repo.branches
+      assert_equal branches, @repo.instance_variable_get(:@refs)
+    end
+
+    should 'be able to load all tags of a repository' do
+      tags = {
+        'v2.3.1' => '034fc81',
+        'v2.4.0' => 'a3c5139',
+        'v2.4.1' => '91940c2'
+      }
+      grit_tags = tags.map do |tag|
+        commit = Grit::Commit.new(nil, tag.last, [], nil, nil, nil, nil, nil, [])
+        Grit::Tag.new tag.first, commit
+      end
+      Grit::Repo.any_instance.expects(:tags).once.returns(grit_tags)
+
+      assert_equal %w{v2.3.1 v2.4.0 v2.4.1}, @repo.tags
+      assert_equal tags, @repo.instance_variable_get(:@refs)
+    end
+
+    should 'be able to load the name and description of the project' do
+      description = "grit\n\nGrit gives you object oriented read/write access to Git repositories via Ruby."
+      Grit::Repo.any_instance.expects(:description).once.returns description
+      @repo.expects(:load_description).never
+
+      assert_equal 'grit', @repo.name
+      assert_equal 'Grit gives you object oriented read/write access to Git repositories via Ruby.', @repo.description
+    end
+
+    should 'ignore the default Git description file' do
+      description = "Unnamed repository; edit this file 'description' to name the repository."
+      Grit::Repo.any_instance.expects(:description).once.returns description
+
+      assert_equal '', @repo.name
+      assert_equal '', @repo.description
+    end
+
   end
 
 end

data/test/test_github.rb

@@ -25,13 +25,18 @@ class TestGitHub < Test::Unit::TestCase
     setup do
       @repo = Metior::GitHub::Repository.new 'mojombo', 'grit'
 
-      api_response = Fixtures.commits_as_rashies(''..'master')
+      @@github_commits = Fixtures.commits_as_rashies(''..'master')
+      api_response = @@github_commits.values
       @commits_stub = Octokit.stubs :commits
       14.times { @commits_stub.returns api_response.shift(35) }
       @commits_stub.then.raises Octokit::NotFound.new(nil)
+
+      @repo.stubs(:id_for_ref).with('master').returns('1b2fe77')
     end
 
     should 'be able to load all commits from the repository\'s default branch' do
+      @repo.expects(:id_for_ref).with('master').once.returns('1b2fe77')
+
       commits = @repo.commits
       assert_equal 460, commits.size
       assert commits.all? { |commit| commit.is_a? Metior::GitHub::Commit }
@@ -41,13 +46,12 @@ class TestGitHub < Test::Unit::TestCase
     end
 
     should 'be able to load a range of commits from the repository' do
-      @commits_stub = Octokit.stubs :commits
-      api_response = Fixtures.commits_as_rashies(''..'4c592b4')
-      14.times { @commits_stub.returns api_response.shift(35) }
-      @commits_stub.raises Octokit::NotFound.new(nil)
-      api_response = Fixtures.commits_as_rashies(''..'ef2870b')
-      13.times { @commits_stub.returns api_response.shift(35) }
-      @commits_stub.then.raises Octokit::NotFound.new(nil)
+      api_response = Fixtures.commits_as_rashies('ef2870b'..'4c592b4').values
+      Octokit.stubs(:commits).returns(api_response).
+        raises(Octokit::NotFound.new nil)
+
+      @repo.expects(:id_for_ref).with('ef2870b').once.returns('ef2870b')
+      @repo.expects(:id_for_ref).with('4c592b4').once.returns('4c592b4')
 
       commits = @repo.commits 'ef2870b'..'4c592b4'
       assert_equal 6, commits.size
@@ -125,7 +129,10 @@ class TestGitHub < Test::Unit::TestCase
     end
 
     should 'provide easy access to simple repository statistics' do
-      stats = Metior.simple_stats :github, 'mojombo', 'grit'
+      Metior::GitHub::Repository.any_instance.expects(:id_for_ref).twice.
+        with('master').returns('1b2fe77')
+
+      stats = Metior.simple_stats :github, 'mojombo/grit'
 
       assert_equal 157, stats[:active_days].size
       assert_equal 460, stats[:commit_count]
@@ -135,6 +142,42 @@ class TestGitHub < Test::Unit::TestCase
       assert_equal 5, stats[:top_contributors].size
     end
 
+    should 'be able to load all the branches of a repository' do
+      branches = {
+        'master' => '1b2fe77',
+        'branch1' => '1234567',
+        'branch2' => '0abcdef'
+      }
+      Octokit.expects(:branches).with('mojombo/grit').once.returns(branches)
+
+      assert_equal %w{branch1 branch2 master}, @repo.branches
+      assert_equal branches, @repo.instance_variable_get(:@refs)
+    end
+
+    should 'be able to load all tags of a repository' do
+      tags = {
+        'v2.3.1' => '034fc81',
+        'v2.4.0' => 'a3c5139',
+        'v2.4.1' => '91940c2'
+      }
+      Octokit.expects(:tags).with('mojombo/grit').once.returns(tags)
+
+      assert_equal %w{v2.3.1 v2.4.0 v2.4.1}, @repo.tags
+      assert_equal tags, @repo.instance_variable_get(:@refs)
+    end
+
+    should 'be able to load the name and description of the project' do
+      repo = Hashie::Mash.new({
+        :name        => 'grit',
+        :description => 'Grit gives you object oriented read/write access to Git repositories via Ruby.'
+      })
+      Octokit.expects(:repo).with('mojombo/grit').once.returns repo
+      @repo.expects(:load_description).never
+
+      assert_equal repo.name, @repo.name
+      assert_equal repo.description, @repo.description
+    end
+
   end
 
 end

data/test/test_metior.rb

@@ -19,7 +19,7 @@ class TestMetior < Test::Unit::TestCase
         Metior.vcs :unknown
         assert false
       rescue
-        assert $!.is_a? RuntimeError
+        assert_instance_of RuntimeError, $!
         assert_equal 'No VCS registered for :unknown', $!.message
       end
     end
@@ -29,6 +29,27 @@ class TestMetior < Test::Unit::TestCase
       assert_kind_of GitHub::Repository, Metior.repository(:github, 'some', 'user')
     end
 
+    should 'allow easy generation of a report' do
+      require File.join(Report::REPORTS_PATH, 'default')
+
+      report1 = mock
+      report1.expects(:generate).once
+      report2 = mock
+      report2.expects(:generate).once
+
+      Report::Default.expects(:new).with() do |repository, range|
+        repository.instance_of?(Git::Repository) &&
+        range == 'master'
+      end.once.returns(report1)
+      Report::Default.expects(:new).with() do |repository, range|
+        repository.instance_of?(GitHub::Repository) &&
+        range == 'development'
+      end.once.returns(report2)
+
+      Metior.report(:git, File.dirname(File.dirname(__FILE__)), '/target/dir' )
+      Metior.report(:github, 'some/user', '/target/dir', 'development')
+    end
+
   end
 
 end

data/test/test_report.rb

@@ -0,0 +1,49 @@
+# 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 TestReport < Test::Unit::TestCase
+
+  context 'A report' do
+
+    setup do
+      require 'metior/repository'
+
+      r = Metior::Repository.new('dummy')
+      r.stubs(:vcs).returns Metior::Git
+      @report = Metior::Report.create 'default', r
+    end
+
+    should 'have some basic information' do
+      assert_instance_of Metior::Report::Default, @report
+      assert_equal 'default', @report.class.name
+      assert_equal [:index], @report.class.views
+      assert_equal File.join(Metior::Report::REPORTS_PATH, 'default'),
+        @report.class.path
+    end
+
+    should 'be able to generate a HTML report using Mustache' do
+      view = mock
+      view.expects(:render).once.returns 'content'
+      view_class = mock
+      view_class.expects(:new).with(@report).once.returns view
+      file = mock
+      file.expects(:write).with('content').once
+      file.expects(:close).once
+
+      target_dir = File.expand_path './a/target/dir'
+      @report.expects(:copy_assets).with(target_dir).once
+      Mustache.expects(:view_namespace=).with(Metior::Report::Default).once
+      Mustache.expects(:view_class).with(:index).once.returns view_class
+      File.expects(:open).with(File.join(target_dir, 'index.html'), 'w').once.
+        returns file
+
+      @report.generate './a/target/dir'
+    end
+
+  end
+
+end

data/test/test_repository.rb

@@ -15,27 +15,64 @@ class TestRepository < Test::Unit::TestCase
       @repo = Metior::Repository.new('dummy')
     end
 
+    should 'load the description of the project on demand' do
+      @repo.expects(:load_description).once
+      @repo.description
+    end
+
+    should 'load the name of the project on demand' do
+      @repo.expects(:load_name).once
+      @repo.name
+    end
+
+    should 'not implement the #id_for_ref method' do
+      assert_raise NotImplementedError do
+        @repo.send :id_for_ref, nil
+      end
+    end
+
+    should 'not implement the #load_branches method' do
+      assert_raise NotImplementedError do
+        @repo.send :load_branches
+      end
+    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')
+    should 'not implement the #load_description' do
+      assert_raise NotImplementedError do
+        @repo.send :load_description
+      end
     end
 
-    should 'hit the cache when loading the same commit range' do
-      @repo.expects(:load_commits).once.returns([])
+    should 'not implement the #load_name method' do
+      assert_raise NotImplementedError do
+        @repo.send :load_name
+      end
+    end
 
-      @repo.commits 'master'
-      @repo.commits 'master'
+    should 'not implement the #load_tags method' do
+      assert_raise NotImplementedError do
+        @repo.send :load_tags
+      end
+    end
+
+    should 'parse commit ranges correctly' do
+      @repo.expects(:id_for_ref).with('master').times(3).returns('abc')
+      @repo.expects(:id_for_ref).with('development').twice.returns('def')
+      assert_equal 'abc'..'def', @repo.send(:parse_range, 'master'..'development')
+      assert_equal 'abc'..'def', @repo.send(:parse_range, 'master..development')
+      assert_equal ''..'abc', @repo.send(:parse_range, 'master')
     end
 
     should 'miss the cache when loading a different commit range' do
-      @repo.expects(:load_commits).twice.returns([])
+      @repo.expects(:id_for_ref).with('master').returns('abc')
+      @repo.expects(:id_for_ref).with('HEAD').returns('abc')
+      @repo.expects(:load_commits).twice.returns([nil, []])
 
       @repo.commits 'master'
       @repo.commits 'HEAD'

data/test/test_vcs.rb

@@ -4,34 +4,57 @@
 # Copyright (c) 2011, Sebastian Staudt
 
 require 'helper'
+require 'metior/vcs'
+
+module MockVCS
+  NAME = :mock
+  include VCS
+  not_supported :some_feature
+end
+Metior.module_exec { @@vcs_types.delete :mock }
 
 class TestVCS < Test::Unit::TestCase
 
   context 'The VCS module' do
 
     setup do
-      require 'metior/vcs'
-
-      module MockVCS
-        NAME = :mock
-        include VCS
-        not_supported :some_feature
-      end
+      Metior.module_exec { @@vcs_types[:mock] = MockVCS }
 
-      @vcs = Object.new
-      @vcs.extend MockVCS
+      @vcs_object = Object.new
+      @vcs_object.extend MockVCS
     end
 
     should 'allow access to the features of a VCS' do
       assert_not MockVCS.supports? :some_feature
-      assert_not @vcs.supports? :some_feature
-      assert_raise UnsupportedError do
-        @vcs.support! :some_feature
+    end
+
+    should 'automatically try to load the VCS implementation files' do
+      MockVCS.expects(:require).with('metior/mock/actor').once
+      MockVCS.expects(:require).with('metior/mock/commit').once
+      MockVCS.expects(:require).with('metior/mock/repository').once
+
+      begin
+        MockVCS::Commit
+      rescue NameError
+      end
+    end
+
+    should 'allow an object of a specific VCS to access the VCS module' do
+      assert_equal MockVCS, @vcs_object.vcs
+    end
+
+    should 'allow an object of a specific VCS to access the VCS features' do
+      assert_not @vcs_object.supports? :some_feature
+      begin
+        @vcs_object.support! :some_feature
+        assert false
+      rescue
+        assert_instance_of UnsupportedError, $!
+        assert_equal "Operation not supported by the current VCS (:mock).", $!.message
       end
     end
 
     teardown do
-      @vcs = nil
       Metior.module_exec { @@vcs_types.delete :mock }
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metior
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sebastian Staudt
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 Z
+date: 2011-08-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,60 +29,60 @@ dependencies:
         - 4
         - 1
         version: 2.4.1
-  prerelease: false
   name: grit
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 7
         segments: 
+        - 1
+        - 4
         - 0
-        - 6
-        - 3
-        version: 0.6.3
+        version: 1.4.0
+  name: hashery
   prerelease: false
-  name: octokit
-  version_requirements: *id002
+  type: :runtime
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 411
         segments: 
         - 0
-        - 9
-        - 1
-        version: 0.9.1
+        - 99
+        - 4
+        version: 0.99.4
+  name: mustache
   prerelease: false
-  name: rake
-  version_requirements: *id003
+  type: :runtime
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 15
         segments: 
         - 0
-        - 7
-        - 1
-        version: 0.7.1
+        - 6
+        - 4
+        version: 0.6.4
+  name: octokit
   prerelease: false
-  name: yard
-  version_requirements: *id004
+  type: :runtime
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,12 +93,28 @@ dependencies:
         - 9
         - 12
         version: 0.9.12
-  prerelease: false
   name: mocha
-  version_requirements: *id005
+  prerelease: false
+  type: :development
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  name: rake
+  prerelease: false
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -110,9 +125,26 @@ dependencies:
         - 11
         - 3
         version: 2.11.3
-  prerelease: false
   name: shoulda
-  version_requirements: *id006
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  name: yard
+  prerelease: false
+  type: :development
+  requirement: *id008
 description: Metior is a source code history analyzer that provides various statistics about a source code repository and its change over time.
 email: 
 - koraktor@gmail.com
@@ -135,6 +167,10 @@ files:
 - lib/core_ext/object.rb
 - lib/metior.rb
 - lib/metior/actor.rb
+- lib/metior/auto_include_vcs.rb
+- lib/metior/collections/actor_collection.rb
+- lib/metior/collections/collection.rb
+- lib/metior/collections/commit_collection.rb
 - lib/metior/commit.rb
 - lib/metior/errors.rb
 - lib/metior/git.rb
@@ -145,17 +181,39 @@ files:
 - lib/metior/github/actor.rb
 - lib/metior/github/commit.rb
 - lib/metior/github/repository.rb
+- lib/metior/report.rb
+- lib/metior/report/view.rb
+- lib/metior/report/view_helper.rb
 - lib/metior/repository.rb
 - lib/metior/vcs.rb
 - lib/metior/version.rb
 - metior.gemspec
+- reports/default.rb
+- reports/default/images/favicon.png
+- reports/default/stylesheets/default.css
+- reports/default/templates/actor/minimal.mustache
+- reports/default/templates/commit/minimal.mustache
+- reports/default/templates/index.mustache
+- reports/default/templates/most_significant_authors.mustache
+- reports/default/templates/most_significant_commits.mustache
+- reports/default/templates/repository_information.mustache
+- reports/default/templates/top_committers.mustache
+- reports/default/views/index.rb
+- reports/default/views/most_significant_authors.rb
+- reports/default/views/most_significant_commits.rb
+- reports/default/views/repository_information.rb
+- reports/default/views/top_committers.rb
 - test/fixtures.rb
 - test/fixtures/mojombo-grit-master-1b2fe77.txt
 - test/helper.rb
-- test/test_class_loading.rb
+- test/test_1st_class_loading.rb
+- test/test_actor_colletion.rb
+- test/test_collection.rb
+- test/test_commit_collection.rb
 - test/test_git.rb
 - test/test_github.rb
 - test/test_metior.rb
+- test/test_report.rb
 - test/test_repository.rb
 - test/test_vcs.rb
 homepage: http://koraktor.de/metior
@@ -187,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: A source code history analyzer API
@@ -195,9 +253,13 @@ test_files:
 - test/fixtures.rb
 - test/fixtures/mojombo-grit-master-1b2fe77.txt
 - test/helper.rb
-- test/test_class_loading.rb
+- test/test_1st_class_loading.rb
+- test/test_actor_colletion.rb
+- test/test_collection.rb
+- test/test_commit_collection.rb
 - test/test_git.rb
 - test/test_github.rb
 - test/test_metior.rb
+- test/test_report.rb
 - test/test_repository.rb
 - test/test_vcs.rb