caelum-git_reports 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.project
+.loadpath
+*~
+*.html
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Caue Guerra
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= caelum-git-reports
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Caue Guerra. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git_reports"
+    gem.summary = "Git report tool"
+    gem.email = "caue.guerra@gmail.com"
+    gem.homepage = "http://github.com/caelum/git-reports"
+    gem.authors = ["Caue Guerra", "Pedro Matiello"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ["--colour --format specdoc"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "caelum-git-reports #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/git-report.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# Load path
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# Requires
+require 'reporter'
+require 'date'
+require 'html_report'
+require 'html_summary'
+
+# Command line arguments
+workdir = ARGV[0]
+days = ARGV[1].to_i
+max_commits = ARGV[2].to_i
+if (max_commits <= 0)
+  max_commits = 50
+end
+
+# Action!
+if (workdir and days > 0)
+  puts "Git stats for repositories under #{workdir}"
+
+  reporter = Reporter.new(workdir)
+  reporter.extract_all_stats(Date.new - days) do |name|
+    puts "Checking #{name}..."
+  end
+
+  now = Time.now.strftime("%Y.%m.%d")
+
+  # Repository stats
+  repository_html = File.new("repositories-#{now}-#{days}.html", "w")
+  repository_html.puts HtmlReport.new(reporter.repository_stats, "Statistics for repositories", days).generate
+  repository_html.close
+
+  # Commiter stats
+  commiter_html = File.new("commiters-#{now}-#{days}.html", "w")
+  commiter_html.puts HtmlReport.new(reporter.commiter_stats, "Statistics for commiters", days).generate
+  commiter_html.close
+
+  # Commit summary
+  summary_html = File.new("summary-#{now}-#{days}.html", "w")
+  summary_html.puts HtmlSummary.new(reporter.repository_summaries, "Summary", days, max_commits).generate
+  summary_html.close
+else
+  puts "Usage: git-report.rb <path to repositories> <number of days to look back> [<number of commits in summary>]"
+end

data/git_reports.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git_reports}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Caue Guerra", "Pedro Matiello"]
+  s.date = %q{2009-06-30}
+  s.default_executable = %q{git-report.rb}
+  s.email = %q{caue.guerra@gmail.com}
+  s.executables = ["git-report.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/git-report.rb",
+     "git_reports.gemspec",
+     "lib/html_report.rb",
+     "lib/html_summary.rb",
+     "lib/reporter.rb",
+     "lib/repository.rb",
+     "lib/template.rb",
+     "spec/html_report_spec.rb",
+     "spec/html_summary_spec.rb",
+     "spec/reporter_spec.rb",
+     "spec/repository_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/caelum/git-reports}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Git report tool}
+  s.test_files = [
+    "spec/html_report_spec.rb",
+     "spec/html_summary_spec.rb",
+     "spec/reporter_spec.rb",
+     "spec/repository_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/html_report.rb

@@ -0,0 +1,34 @@
+require 'template'
+require 'time'
+
+class HtmlReport
+
+include Template
+
+  def initialize(stats, title, days)
+    @stats = stats
+    @title = title
+    @days = days
+  end
+
+  def generate
+    report = ''
+
+    from = (Time.now - @days*60*60*24).strftime("%Y.%m.%d")
+    to = Time.now.strftime("%Y.%m.%d")
+
+    report << Template::HEAD.gsub('%TITLE%', @title).gsub("%FROM%", from).gsub('%TO%', to)
+    for major in @stats.keys
+      report << Template::MAJOR_HEAD.gsub('%MAJOR%', major)
+      sum = 0
+      for minor, lines in @stats[major]
+        report << Template::MINOR.gsub('%MINOR%', minor).gsub('%LINES%', lines.to_s)
+        sum += lines
+      end
+      report << Template::MINOR.gsub('%MINOR%', '.').gsub('%LINES%', sum.to_s)
+      report << Template::MAJOR_TAIL
+    end
+    report << Template::TAIL
+  end
+
+end

data/lib/html_summary.rb

@@ -0,0 +1,63 @@
+require 'template'
+require 'time'
+
+class HtmlSummary
+
+include Template
+
+  def initialize(summaries, title, days, max_commits)
+    @summaries = summaries
+    @title = title
+    @days = days
+    @summary = Hash.new
+    @max_commits = max_commits
+  end
+
+  def generate
+    report = ''
+
+    from = (Time.now - @days*60*60*24).strftime("%Y.%m.%d")
+    to = Time.now.strftime("%Y.%m.%d")
+
+    report << Template::HEAD.gsub('%TITLE%', @title).gsub("%FROM%", from).gsub('%TO%', to)
+    merge
+
+    for commit in @summary.keys.sort.reverse[0..@max_commits-1]
+      report << Template::COMMIT.gsub("%REPOSITORY%", @summary[commit][:repository] || "nil").
+                                 gsub("%MESSAGE%", @summary[commit][:message] || "nil").
+                                 gsub("%COMMITER%", @summary[commit][:commiter] || "nil").
+                                 gsub("%TIMEDATE%", @summary[commit][:time].to_s || "nil")
+    end
+
+    report << Template::TAIL
+
+    return report
+  end
+
+  def merge
+    # List all timestamps and sort
+    timestamps = []
+    for repository in @summaries.keys
+      for timestamp in @summaries[repository].keys
+        timestamps.push timestamp
+      end
+    end
+    timestamps.sort!
+
+    # Put commits from all repositories together, ordered by their timestamps
+    i = 0
+    for timestamp in timestamps
+      for repository in @summaries.keys
+        if (@summaries[repository][timestamp])
+          @summary[i] = Hash.new
+          @summary[i][:repository] = repository
+          @summary[i][:message] = @summaries[repository][timestamp][:message]
+          @summary[i][:commiter] = @summaries[repository][timestamp][:commiter]
+          @summary[i][:time] = @summaries[repository][timestamp][:time]
+          i = i + 1
+        end
+      end
+    end
+  end
+
+end

data/lib/reporter.rb

@@ -0,0 +1,58 @@
+require 'repository'
+require 'date'
+
+class Reporter
+  attr_accessor :work_dir
+  attr_reader :repositories
+  attr_accessor :repository_stats, :commiter_stats, :repository_summaries
+
+  def initialize(work_dir)
+    @work_dir = work_dir
+    @repositories = Hash.new
+    @repository_stats = Hash.new
+    @commiter_stats = Hash.new
+    @repository_summaries = Hash.new
+    discover_repositories
+    initialize_repositories
+  end
+
+  def extract_stats(repository_name, from = Date.new, to = Date.new)
+    @repository_stats[repository_name] = Hash.new
+    repository = @repositories[repository_name]
+    repository.pull
+    repository.calculate_stats(from, to)
+    repository.generate_summary(from, to)
+    @repository_summaries[repository_name] = repository.summary
+    for commiter in repository.commiters.keys
+      @repository_stats[repository_name][commiter] = repository.commiters[commiter]
+    end
+    extract_stats_for_commiters(repository_name)
+  end
+
+  def extract_all_stats(from = Date.new, to = Date.new)
+    for repository in @repositories.values
+      yield repository.name if block_given?
+      extract_stats(repository.name, from, to)
+    end
+  end
+
+  private
+  def extract_stats_for_commiters(repository_name)
+    for commiter, lines in @repository_stats[repository_name]
+      @commiter_stats[commiter] = Hash.new unless @commiter_stats[commiter].instance_of? Hash
+      @commiter_stats[commiter][repository_name] = lines
+    end
+  end
+
+  private
+  def discover_repositories
+    @repositories_names = `cd #{work_dir} && ls`.split("\n")
+  end
+
+  def initialize_repositories
+    for repository_name in @repositories_names
+      repository = Repository.new(repository_name, @work_dir + "/#{repository_name}")
+      @repositories[repository_name] = repository
+    end
+  end
+end

data/lib/repository.rb

@@ -0,0 +1,72 @@
+require 'date'
+require 'time'
+
+class Repository
+  attr_accessor :name, :dir, :url
+  attr_reader :commiters, :summary
+
+  def initialize(name, dir)
+    @name = name
+    @dir = dir
+    @delimiter = "#{200.chr}@@@"
+  end
+
+  def clone
+    `cd #{dir} && git clone #{url} > /dev/null 2>&1`
+  end
+
+  def pull
+    `cd #{dir} && git pull`
+  end
+
+  def extract_log(from = Date.new, to = Date.new)
+    start_date = "#{Date.new - from} days ago"
+    end_date = "#{Date.new - to} days ago"
+    log = `cd #{dir} && git log --since="#{start_date}" --until="#{end_date} days ago" --pretty=tformat:"%n%an" --numstat --ignore-space-change`
+    return log
+  end
+
+  def extract_log_with_messages(from = Date.new, to = Date.new)
+    start_date = "#{Date.new - from} days ago"
+    end_date = "#{Date.new - to} days ago"
+    log = `cd #{dir} && git log --since="#{start_date}" --until="#{end_date} days ago" --pretty=tformat:"%an%n%at%n%s#{@delimiter}"`
+    return log
+  end
+
+  def generate_summary(from = Date.new, to = Date.new)
+    log = self.extract_log_with_messages(from, to)
+    @summary = Hash.new
+    for commit in log.split(@delimiter)
+      temp = []
+      for info in commit.split("\n")
+        temp.push info unless info == ""
+      end
+      @summary[temp[1]] = {:commiter => temp[0], :time => Time.at(temp[1].to_i), :message => temp[2]} if temp[1]
+    end
+  end
+
+  def calculate_stats(from = Date.new, to = Date.new)
+    regexp = Regexp.new('\A((\w+\s?)+)\s*((([\d-]+\s+[\d-]+.*)*\s)*)')
+    log = self.extract_log(from, to)
+    log[0] = '' unless log == ""
+
+    match = regexp.match(log)
+    @commiters = Hash.new
+    while !match.nil?
+      email = match[1].gsub("\n", "")
+
+      if @commiters[email].nil?
+        @commiters[email] = 0
+      end
+
+      commit_informations = match[3]
+      commit_informations.split("\n")
+      for commit_information in commit_informations
+        item = commit_information.split(/\s+/)
+        @commiters[email] += item[0].to_i + item[1].to_i
+      end
+      log.gsub!(regexp,"")
+      match = regexp.match(log)
+    end
+  end
+end

data/lib/template.rb

@@ -0,0 +1,46 @@
+module Template
+
+HEAD = <<-HEADER
+<html>
+  <head>
+    <title>%TITLE%</title>
+  </head>
+  <body>
+  <h2>%TITLE%</h2>
+  <p>From %FROM% to %TO%</p>
+HEADER
+
+TAIL = <<-TAIL
+  </body>
+</html>
+TAIL
+
+MAJOR_HEAD = <<-MAJOR
+    <br>
+    <table border=1; width="600px">
+      <tr>
+        <td width="450px"><strong>%MAJOR%</strong></td>
+        <td width="150px"><strong>Lines</strong></td>
+      </tr>
+MAJOR
+
+MAJOR_TAIL = <<-MAJOR
+    </table>
+MAJOR
+
+MINOR = <<-MINOR
+      <tr>
+        <td>%MINOR%</td>
+        <td>%LINES%</td>
+      </tr>
+MINOR
+
+COMMIT = <<-COMMIT
+    <br>
+    <table border=1; width="600px">
+      <tr><td><strong>%REPOSITORY%</strong></td></tr>
+      <tr><td>%MESSAGE%</td></tr>
+      <tr><td><strong>by</strong> %COMMITER% <strong>at</strong> %TIMEDATE%</td></tr>
+    </table>
+COMMIT
+end

data/spec/html_report_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'repository'
+require 'html_report'
+require 'time'
+
+describe "HtmlReport" do
+
+  before :each do
+    stats = Hash.new
+    stats['Major1'] = Hash.new
+    stats['Major1']['Minor1'] = 100
+    stats['Major1']['Minor2'] = 200
+    stats['Major2'] = Hash.new
+    stats['Major2']['Minor2'] = 222
+    stats['Major2']['Minor3'] = 333
+    @report = HtmlReport.new(stats, "Statistics for repositories!", 123).generate
+  end
+
+  it "should have a title" do
+    @report.should include("Statistics for repositories!")
+  end
+
+  it "should specify the considered date" do
+    from = (Time.now - 123*60*60*24).strftime("%Y.%m.%d")
+    to = Time.now.strftime("%Y.%m.%d")
+    @report.should include("From #{from} to #{to}")
+  end
+
+  it "should include all majors" do
+    @report.should include("Major1")
+    @report.should include("Major2")
+  end
+
+  it "should include all minors" do
+    @report.should include("Minor1")
+    @report.should include("Minor2")
+    @report.should include("Minor3")
+  end
+
+  it "should include the line impact for each minor in each major" do
+    @report.should include("100")
+    @report.should include("200")
+    @report.should include("222")
+    @report.should include("333")
+  end
+
+  it "should include the sum of all minors for each major" do
+    @report.should include("300")
+    @report.should include("555")
+  end
+
+end

data/spec/html_summary_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'repository'
+require 'html_summary'
+require 'time'
+
+describe "HtmlSummary" do
+
+  before :each do
+    stats = Hash.new
+    stats['Repo1'] = Hash.new
+    stats['Repo1']['1'] = {:commiter => "Commiter 1", :time => "Time 1", :message => "Message 1"}
+    stats['Repo1']['3'] = {:commiter => "Commiter 2", :time => "Time 3", :message => "Message 3"}
+    stats['Repo1']['5'] = {:commiter => "Commiter 3", :time => "Time 5", :message => "Message 5"}
+    stats['Repo2'] = Hash.new
+    stats['Repo2']['2'] = {:commiter => "Commiter 3", :time => "Time 2", :message => "Message 2"}
+    stats['Repo2']['4'] = {:commiter => "Commiter 3", :time => "Time 4", :message => "Message 4"}
+    @report = HtmlSummary.new(stats, "Summary!", 123, 4).generate
+  end
+
+  it "should have a title" do
+    @report.should include("Summary!")
+  end
+
+  it "should specify the considered date" do
+    from = (Time.now - 123*60*60*24).strftime("%Y.%m.%d")
+    to = Time.now.strftime("%Y.%m.%d")
+    @report.should include("From #{from} to #{to}")
+  end
+
+  it "should include the repository name" do
+    @report.should include("Repo1")
+    @report.should include("Repo2")
+  end
+
+  it "should include the commit message" do
+    @report.should_not include("Message 1")
+    @report.should include("Message 2")
+    @report.should include("Message 3")
+    @report.should include("Message 4")
+    @report.should include("Message 5")
+  end
+
+  it "should include commiter's name" do
+    @report.should_not include("Commiter 1")
+    @report.should include("Commiter 2")
+    @report.should include("Commiter 3")
+  end
+
+  it "should include the time and date for each commit" do
+    @report.should_not include("Time 1")
+    @report.should include("Time 2")
+    @report.should include("Time 3")
+    @report.should include("Time 4")
+    @report.should include("Time 5")
+  end
+
+end

data/spec/reporter_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CaelumGitReports" do
+
+end

data/spec/repository_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'repository'
+
+describe "Repository" do
+
+  it "should calculate stats" do
+    log = "
+User1
+
+5 3 File1
+2 2 File2
+
+User1
+
+1 1 File1
+2 2 File3
+
+User2
+
+7 0 File1
+0 3 File2
+"
+
+    repository = Repository.new("SampleRepository","ArbitraryDirectory")
+    repository.stub(:extract_log).and_return(log)
+    repository.calculate_stats
+    repository.commiters['User1'].should be(18)
+    repository.commiters['User2'].should be(10)
+  end
+
+  it "should generate a summary" do
+    delimiter = "#{200.chr}@@@"
+    log = "User 1
+12345
+Message number 1#{delimiter}
+User 2
+12344
+Message number 2#{delimiter}
+"
+    repository = Repository.new("SampleRepository","ArbitraryDirectory")
+    repository.stub(:extract_log_with_messages).and_return(log)
+    repository.generate_summary
+    repository.summary['12345'][:commiter].should eql("User 1")
+    repository.summary['12345'][:time].should eql(Time.at(12345))
+    repository.summary['12345'][:message].should eql("Message number 1")
+    repository.summary['12344'][:commiter].should eql("User 2")
+    repository.summary['12344'][:time].should eql(Time.at(12344))
+    repository.summary['12344'][:message].should eql("Message number 2")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: caelum-git_reports
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Caue Guerra
+- Pedro Matiello
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-30 00:00:00 -07:00
+default_executable: git-report.rb
+dependencies: []
+
+description: 
+email: caue.guerra@gmail.com
+executables: 
+- git-report.rb
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/git-report.rb
+- git_reports.gemspec
+- lib/html_report.rb
+- lib/html_summary.rb
+- lib/reporter.rb
+- lib/repository.rb
+- lib/template.rb
+- spec/html_report_spec.rb
+- spec/html_summary_spec.rb
+- spec/reporter_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/caelum/git-reports
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Git report tool
+test_files: 
+- spec/html_report_spec.rb
+- spec/html_summary_spec.rb
+- spec/reporter_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb