git-commit-notifier 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,22 @@
+ Copyright (c) 2008 Csoma Zoltan, Primalgrasp
+ 
+ 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.textile

@@ -0,0 +1,54 @@
+_h1. Git Commit Notifier
+
+<pre>by Bodo Tasche (bodo 'at' wannawork 'dot' de), Csoma Zoltan (Primalgrasp) (zoltan 'at' primalgrasp 'dot' com)</pre>
+
+Sends email commit messages splitting commits that were pushed in one
+step. Email is delivered as text or HTML with changes refined per
+word. Emails have a scanable subject containing the first sentence of
+the commit as well as the author, project and branch name.
+
+For example:
+<pre>[rails][master] Fix Brasilia timezone. [#1180 state:resolved] </pre>
+
+A reply-to header is added containing the author of the commit. This makes follow up really simple. If multiple commits are pushed at once, emails are numbered in chronological order:
+<pre>
+ [rails][master][000] Added deprecated warning messages to Float#months and Float#years deprications.
+ [rails][master][001] Enhance testing for fractional days and weeks. Update changelog.
+</pre>
+
+Example email:
+
+!http://img171.imageshack.us/img171/954/gitcommitnotifieremailpq3.png!
+
+h1. Requirements
+
+* Ruby
+* RubyGems
+* diff/lcs gem
+* SMTP server or sendmail compatible mailer
+* mocha, hpricot gems for testing
+
+h1. Installing and Configuring
+
+Before installing the Git Commit Notification script, make sure the following Git settings are correct:
+* git config hooks.mailinglist (email address of the recipient, probably your mailing list address)
+* git config hooks.emailprefix (application name, used in email subject)
+
+See /usr/local/share/git_commit_notifier/config/config.yml for overriding these settings
+
+Run the automated installation script:
+  <pre>sudo gem install git-commit-notifier</pre>
+
+After you installed the gem, you need to configure your git repository. Add a File called "post-receive" to the __hooks__
+directory and add this content:
+
+<pre>
+    #!/bin/sh
+    git-commit-notifier path_to_config.yml
+</pre>
+
+And don't forget to make that file executable. An example for the config-file can be found in __/usr/local/share/git_commit_notifier/config/config.yml__ .
+
+h1. License
+
+MIT License, see the file LICENSE.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git-commit-notifier"
+    gem.summary = %Q{Sends git commit messages with diffs}
+    gem.description = %Q{This git commit notifier sends html mails with nice diffs for every changed file.}
+    gem.email = "bodo@wannawork.de"
+    gem.homepage = "http://github.com/bodo/git-commit-notifier"
+    gem.authors = ["Bodo Tasche"]
+    gem.add_dependency('diff-lcs')
+    gem.add_dependency('mocha')
+    gem.add_dependency('hpricot')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "git-commit-notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/git-commit-notifier

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# parameters: revision1, revision 2, branch
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+$:.unshift File.join(File.dirname(THIS_FILE), "../lib")
+require "commit_hook"
+
+if ARGV.length == 0
+  CommitHook.show_error("You have to add a path to the config file for git-commit-notifier")
+elsif ARGV.length == 1
+  param = STDIN.gets.strip.split
+  CommitHook.run ARGV[0], param[0], param[1], param[2]
+else
+  CommitHook.run ARGV[0], ARGV[1], ARGV[2]
+end

data/config/git-notifier-configl.yml.sample

@@ -0,0 +1,15 @@
+delivery_method: sendmail # smtp or sendmail
+
+smtp_server:
+  address: localhost
+  port: 25
+  domain: localhost
+  user_name:
+  password:
+  authentication:
+
+sendmail_options:
+  location: /usr/sbin/sendmail
+  arguments:
+
+

data/git-commit-notifier.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-commit-notifier}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bodo Tasche"]
+  s.date = %q{2010-03-24}
+  s.default_executable = %q{git-commit-notifier}
+  s.description = %q{This git commit notifier sends html mails with nice diffs for every changed file.}
+  s.email = %q{bodo@wannawork.de}
+  s.executables = ["git-commit-notifier"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/git-commit-notifier",
+     "config/git-notifier-configl.yml.sample",
+     "git-commit-notifier.gemspec",
+     "lib/commit_hook.rb",
+     "lib/diff_to_html.rb",
+     "lib/emailer.rb",
+     "lib/git.rb",
+     "lib/result_processor.rb",
+     "template/email.html.erb",
+     "template/styles.css",
+     "test/fixtures/git_log",
+     "test/fixtures/git_show_51b986619d88f7ba98be7d271188785cbbb541a0",
+     "test/fixtures/git_show_a4629e707d80a5769f7a71ca6ed9471015e14dc9",
+     "test/fixtures/git_show_dce6ade4cdc2833b53bd600ef10f9bce83c7102d",
+     "test/fixtures/git_show_e28ad77bba0574241e6eb64dfd0c1291b221effe",
+     "test/test_helper.rb",
+     "test/unit/test_commit_hook.rb",
+     "test/unit/test_diff_to_html.rb",
+     "test/unit/test_result_processor.rb"
+  ]
+  s.homepage = %q{http://github.com/bodo/git-commit-notifier}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Sends git commit messages with diffs}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/unit/test_commit_hook.rb",
+     "test/unit/test_diff_to_html.rb",
+     "test/unit/test_result_processor.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
+      s.add_runtime_dependency(%q<diff-lcs>, [">= 0"])
+      s.add_runtime_dependency(%q<mocha>, [">= 0"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+    else
+      s.add_dependency(%q<diff-lcs>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<diff-lcs>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
+  end
+end
+

data/lib/commit_hook.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'cgi'
+require 'net/smtp'
+require 'sha1'
+
+require 'diff_to_html'
+require 'emailer'
+require 'git'
+
+class CommitHook
+
+  def self.show_error(message)
+    puts "************** GIT NOTIFIER PROBLEM *******************"
+    puts "\n"
+    puts message
+    puts "\n"
+    puts "************** GIT NOTIFIER PROBLEM *******************"
+  end
+
+  def self.run(config, rev1, rev2, ref_name)
+    project_path = Dir.getwd
+    recipient = Git.mailing_list_address
+    
+    if (recipient.nil? || recipient.length == 0)
+      CommitHook.show_error(
+                "Please add a recipient for the emails. Eg : \n" + 
+                "      git config hooks.mailinglist  developer@example.com")
+      return
+    end
+    
+    prefix = Git.repo_name
+    branch_name = (ref_name =~ /master$/i) ? "" : "/#{ref_name.split("/").last}"
+
+    @config = {}
+    @config = YAML::load_file(config) if File.exist?(config)
+
+    diff2html = DiffToHtml.new(Dir.pwd)
+    diff2html.diff_between_revisions rev1, rev2, prefix, ref_name
+    diff2html.result.reverse.each_with_index do |result, i|
+      nr = number(diff2html.result.size, i)
+      emailer = Emailer.new @config, project_path, recipient, result[:commit_info][:email], result[:commit_info][:author],
+                     "[#{prefix}#{branch_name}]#{nr} #{result[:commit_info][:message]}", result[:text_content], result[:html_content], rev1, rev2, ref_name
+      emailer.send
+    end
+  end
+
+  def self.number(total_entries, i)
+    return '' if total_entries <= 1
+    digits = total_entries < 10 ? 1 : 3
+    '[' + sprintf("%0#{digits}d", i) + ']'
+  end
+
+end

data/lib/diff_to_html.rb

@@ -0,0 +1,321 @@
+require 'rubygems'
+require 'diff/lcs'
+require File.dirname(__FILE__) + '/result_processor'
+
+def escape_content(s)
+  CGI.escapeHTML(s).gsub(" ", " ")
+end
+
+class DiffToHtml
+  attr_accessor :file_prefix
+  attr_reader :result
+
+  def initialize(config_dir = nil)
+    @previous_dir = config_dir
+  end
+
+  def range_info(range)
+    range.match(/^@@ \-(\d+),\d+ \+(\d+),\d+ @@/)
+    left_ln = Integer($1)
+    right_ln = Integer($2)
+    return left_ln, right_ln
+  end
+
+  def line_class(line)
+    if line[:op] == :removal
+      return " class=\"r\""
+    elsif line[:op] == :addition
+      return " class=\"a\""
+    else
+      return ''
+    end
+  end
+
+  def add_block_to_results(block, escape)
+    return if block.empty?
+    block.each do |line|
+      add_line_to_result(line, escape)
+    end
+  end
+
+  def add_line_to_result(line, escape)
+    klass = line_class(line)
+    content = escape ? escape_content(line[:content]) : line[:content]
+    padding = ' ' if klass != ''
+    @diff_result << "<tr#{klass}>\n<td class=\"ln\">#{line[:removed]}</td>\n<td class=\"ln\">#{line[:added]}</td>\n<td>#{padding}#{content}</td></tr>"
+  end
+
+  def extract_block_content(block)
+    block.collect { |b| b[:content]}.join("\n")
+  end
+
+  def lcs_diff(removals, additions)
+    # arrays always have at least 1 element
+    callback = DiffCallback.new
+
+    s1 = extract_block_content(removals)
+    s2 = extract_block_content(additions)
+
+    s1 = tokenize_string(s1)
+    s2 = tokenize_string(s2)
+
+    Diff::LCS.traverse_balanced(s1, s2, callback)
+
+    processor = ResultProcessor.new(callback.tags)
+
+    diff_for_removals, diff_for_additions = processor.results
+    result = []
+
+    ln_start = removals[0][:removed]
+    diff_for_removals.each_with_index do |line, i|
+      result << { :removed => ln_start + i, :added => nil, :op => :removal, :content => line}
+    end
+
+    ln_start = additions[0][:added]
+    diff_for_additions.each_with_index do |line, i|
+      result << { :removed => nil, :added => ln_start + i, :op => :addition, :content => line}
+    end
+
+    result
+  end
+
+  def tokenize_string(str)
+    # tokenize by non-alphanumerical characters
+    tokens = []
+    token = ''
+    str = str.split('')
+    str.each_with_index do |char, i|
+      alphanumeric = !char.match(/[a-zA-Z0-9]/).nil?
+      if !alphanumeric || str.size == i+1
+        token += char if alphanumeric
+        tokens << token unless token.empty?
+        tokens << char unless alphanumeric
+        token = ''
+      else
+        token += char
+      end
+    end
+    return tokens
+  end
+
+  def operation_description
+    binary = @binary ? 'binary ' : ''
+    if @file_removed
+      op = "Deleted"
+    elsif @file_added
+      op = "Added"
+    else
+      op = "Changed"
+    end
+    header = "#{op} #{binary}file #{@current_file_name}"
+    "<h2>#{header}</h2>\n"
+  end
+
+  def add_changes_to_result
+    return if @current_file_name.nil?
+    @diff_result << operation_description
+    @diff_result << '<table>'
+    unless @diff_lines.empty?
+      removals = []
+      additions = []
+      @diff_lines.each do |line|
+        if [:addition, :removal].include?(line[:op])
+          removals << line if line[:op] == :removal
+          additions << line if line[:op] == :addition
+        end
+        if line[:op] == :unchanged || line == @diff_lines.last # unchanged line or end of block, add prev lines to result
+          if removals.size > 0 && additions.size > 0 # block of removed and added lines - perform intelligent diff
+            add_block_to_results(lcs_diff(removals, additions), escape = false)
+          else # some lines removed or added - no need to perform intelligent diff
+            add_block_to_results(removals + additions, escape = true)
+          end
+          removals = []
+          additions = []
+          add_line_to_result(line, escape = true) if line[:op] == :unchanged
+        end
+      end
+      @diff_lines = []
+      @diff_result << '</table>'
+    end
+    # reset values
+    @right_ln = nil
+    @left_ln = nil
+    @file_added = false
+    @file_removed = false
+    @binary = false
+  end
+
+  def diff_for_revision(content)
+    @left_ln = @right_ln = nil
+
+    @diff_result = []
+    @diff_lines = []
+    @removed_files = []
+    @current_file_name = nil
+
+    content.split("\n").each do |line|
+      if line =~ /^diff\s\-\-git/
+        line.match(/diff --git a\/(.*)\sb\//)
+        file_name = $1
+        add_changes_to_result
+        @current_file_name = file_name
+      end
+
+      op = line[0,1]
+      @left_ln.nil? || op == '@' ? process_info_line(line, op) : process_code_line(line, op)
+    end
+    add_changes_to_result
+    @diff_result.join("\n")
+  end
+
+  def process_code_line(line, op)
+    if op == '-'
+      @diff_lines << { :removed => @left_ln, :added => nil, :op => :removal, :content => line[1..-1] }
+      @left_ln += 1
+    elsif op == '+'
+      @diff_lines << { :added => @right_ln, :removed => nil, :op => :addition, :content => line[1..-1] }
+      @right_ln += 1
+    else @right_ln
+      @diff_lines << { :added => @right_ln, :removed => @left_ln, :op => :unchanged, :content => line }
+      @right_ln += 1
+      @left_ln += 1
+    end
+  end
+
+  def process_info_line(line, op)
+    if line =~/^deleted\sfile\s/
+      @file_removed = true
+    elsif line =~ /^\-\-\-\s/ && line =~ /\/dev\/null/
+      @file_added = true
+    elsif line =~ /^\+\+\+\s/ && line =~ /\/dev\/null/
+      @file_removed = true
+    elsif line =~ /^Binary files \/dev\/null/ # Binary files /dev/null and ... differ (addition)
+      @binary = true
+      @file_added = true
+    elsif line =~ /\/dev\/null differ/ # Binary files ... and /dev/null differ (removal)
+      @binary = true
+      @file_removed = true
+    elsif op == '@'
+      @left_ln, @right_ln = range_info(line)
+    end
+  end
+
+  def extract_diff_from_git_show_output(content)
+    diff = []
+    diff_found = false
+    content.split("\n").each do |line|
+      diff_found = true if line =~ /^diff \-\-git/
+      next unless diff_found
+      diff << line
+    end
+    diff.join("\n")
+  end
+
+  def extract_commit_info_from_git_show_output(content)
+    result = { :message => [], :commit => '', :author => '', :date => '', :email => '' }
+    content.split("\n").each do |line|
+      if line =~ /^diff/ # end of commit info, return results
+        return result
+      elsif line =~ /^commit/
+        result[:commit] = line[7..-1]
+      elsif line =~ /^Author/
+        result[:author], result[:email] = author_name_and_email(line[8..-1])
+      elsif line =~ /^Date/
+        result[:date] = line[8..-1]
+      else
+        clean_line = line.strip
+        result[:message] << clean_line unless clean_line.empty?
+      end
+    end
+    result
+  end
+
+  def message_array_as_html(message)
+    message.collect { |m| CGI.escapeHTML(m)}.join("<br />")
+  end
+
+  def author_name_and_email(info)
+    # input string format: "autor name <author@email.net>"
+    result = info.scan(/(.*)\s<(.*)>/)[0]
+    return result if result.is_a?(Array) && result.size == 2 # normal operation
+    # incomplete author info - return it as author name
+    return [info, ''] if result.nil?
+  end
+
+  def first_sentence(message_array)
+    msg = message_array.first.to_s.strip
+    return message_array.first if msg.empty? || msg =~ /^Merge\:/
+    msg
+  end
+
+  def diff_between_revisions(rev1, rev2, repo, branch)
+    @result = []
+    if rev1 == rev2
+      commits = [rev1]
+    elsif rev1 =~ /^0+$/
+      # creating a new remote branch
+      commits = Git.branch_commits(branch)
+    elsif rev2 =~ /^0+$/
+      # deleting an existing remote branch
+      commits = []
+    else
+      log = Git.log(rev1, rev2)
+      commits = log.scan(/^commit\s([a-f0-9]+)/).map{|match| match[0]}
+    end
+
+    if defined?(Test::Unit)
+      previous_list = []
+    else
+      previous_file = (!@previous_dir.nil? && File.exists?(@previous_dir)) ? File.join(@previous_dir, "previously.txt") : "/tmp/previously.txt"
+      previous_list = (File.read(previous_file).to_a.map {|sha| sha.chomp!} if File.exist?(previous_file)) || []
+    end
+
+    commits.reject!{|c| c.find{|sha| previous_list.include?(sha)} }
+    current_list = (previous_list + commits.flatten).last(1000)
+    File.open(previous_file, "w"){|f| f << current_list.join("\n") } unless current_list.empty? || defined?(Test::Unit)
+
+    commits.each_with_index do |commit, i|
+      raw_diff = Git.show(commit)
+      raise "git show output is empty" if raw_diff.empty?
+      @last_raw = raw_diff
+
+      commit_info = extract_commit_info_from_git_show_output(raw_diff)
+
+      title = "<div class=\"title\">"
+      title += "<strong>Message:</strong> #{message_array_as_html commit_info[:message]}<br />\n"
+      title += "<strong>Commit</strong> #{commit_info[:commit]}<br />\n"
+      title += "<strong>Branch:</strong> #{branch}\n<br />" unless branch =~ /\/head/
+      title += "<strong>Date:</strong> #{CGI.escapeHTML commit_info[:date]}\n<br />"
+      title += "<strong>Author:</strong> #{CGI.escapeHTML(commit_info[:author])} &lt;#{commit_info[:email]}&gt;\n</div>"
+
+      text = "#{raw_diff}\n\n\n"
+
+      html = title
+      html += diff_for_revision(extract_diff_from_git_show_output(raw_diff))
+      html += "<br /><br />"
+      commit_info[:message] = first_sentence(commit_info[:message])
+      @result << {:commit_info => commit_info, :html_content => html, :text_content => text }
+    end
+  end
+end
+
+class DiffCallback
+  attr_reader :tags
+
+  def initialize
+    @tags = []
+  end
+
+  def match(event)
+    @tags << { :action => :match, :token => event.old_element }
+  end
+
+  def discard_b(event)
+    @tags << { :action => :discard_b, :token => event.new_element }
+  end
+
+  def discard_a(event)
+    @tags << { :action => :discard_a, :token => event.old_element }
+  end
+
+end