git-commit-notifier 0.8.0 → 0.8.1

data/lib/diff_to_html.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'diff/lcs'
+require 'digest/sha1'
+
 require File.dirname(__FILE__) + '/result_processor'
 
 def escape_content(s)
@@ -10,16 +12,23 @@ class DiffToHtml
   INTEGRATION_MAP = {
     :mediawiki => { :search_for => /\[\[([^\[\]]+)\]\]/, :replace_with => '#{url}/\1' },
     :redmine => { :search_for => /\b(?:refs|fixes)\s*\#(\d+)/i, :replace_with => '#{url}/issues/show/\1' },
-    :bugzilla => { :search_for => /\bBUG\s*(\d+)/i, :replace_with => '#{url}/show_bug.cgi?id=\1' }
+    :bugzilla => { :search_for => /\bBUG\s*(\d+)/i, :replace_with => '#{url}/show_bug.cgi?id=\1' },
+    :fogbugz => { :search_for => /\bbugzid:\s*(\d+)/i, :replace_with => '#{url}\1' }
   }.freeze
-  
+  MAX_COMMITS_PER_ACTION = 10000
+  HANDLED_COMMITS_FILE = 'previously.txt'.freeze
+  NEW_HANDLED_COMMITS_FILE = 'previously_new.txt'.freeze
+
   attr_accessor :file_prefix, :current_file_name
-  attr_reader :result
+  attr_reader :result, :branch
 
   def initialize(previous_dir = nil, config = nil)
     @previous_dir = previous_dir
     @config = config || {}
     @lines_added = 0
+    @file_added = false
+    @file_removed = false
+    @binary = false
   end
 
   def range_info(range)
@@ -44,9 +53,17 @@ class DiffToHtml
     end
   end
 
+  def lines_per_diff
+    @config['lines_per_diff']
+  end
+
+  def add_separator
+    return if lines_per_diff && @lines_added >= lines_per_diff
+    @diff_result << '<tr class="sep"><td class="sep" colspan="3" title="Unchanged content skipped between diff. blocks">&hellip;</td></tr>'
+  end
+
   def add_line_to_result(line, escape)
     @lines_added += 1
-    lines_per_diff = @config['lines_per_diff']
     if lines_per_diff
       if @lines_added == lines_per_diff
         @diff_result << '<tr><td colspan="3">Diff too large and stripped&hellip;</td></tr>'
@@ -62,7 +79,7 @@ class DiffToHtml
   end
 
   def extract_block_content(block)
-    block.collect { |b| b[:content]}.join("\n")
+    block.collect { |b| b[:content] }.join("\n")
   end
 
   def lcs_diff(removals, additions)
@@ -96,22 +113,22 @@ class DiffToHtml
   end
 
   def tokenize_string(str)
-    # tokenize by non-alphanumerical characters
+    # tokenize by non-word 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 = ''
+    str.scan(/./mu) do |ch|
+      if ch =~ /[^\W_]/u
+        token += ch
       else
-        token += char
+        unless token.empty?
+          tokens << token
+          token = ''
+        end
+        tokens << ch
       end
     end
-    return tokens
+    tokens << token unless token.empty?
+    tokens
   end
 
   def operation_description
@@ -123,19 +140,31 @@ class DiffToHtml
     else
       op = "Changed"
     end
-    
+
     file_name = @current_file_name
-    
+
     if (@config["link_files"] && @config["link_files"] == "gitweb" && @config["gitweb"])
       file_name = "<a href='#{@config['gitweb']['path']}?p=#{@config['gitweb']['project']};f=#{file_name};hb=HEAD'>#{file_name}</a>"
     elsif (@config["link_files"] && @config["link_files"] == "gitorious" && @config["gitorious"])
-      file_name = "<a href='#{@config['gitorious']['path']}/#{@config['gitorious']['project']}/#{@config['gitorious']['repository']}/blobs/HEAD/#{file_name}'>#{file_name}</a>"
+      file_name = "<a href='#{@config['gitorious']['path']}/#{@config['gitorious']['project']}/#{@config['gitorious']['repository']}/blobs/#{branch}/#{file_name}'>#{file_name}</a>"
+    elsif (@config["link_files"] && @config["link_files"] == "cgit" && @config["cgit"])
+      file_name = "<a href='#{@config['cgit']['path']}/#{@config['cgit']['project']}/tree/#{file_name}'>#{file_name}</a>"
     end
-    
+
     header = "#{op} #{binary}file #{file_name}"
     "<h2>#{header}</h2>\n"
   end
 
+  def lines_are_sequential?(first, second)
+    result = false
+    [:added, :removed].each do |side|
+      if !first[side].nil? && !second[side].nil?
+        result = true if first[side] == (second[side] - 1)
+      end
+    end
+    result
+  end
+
   def add_changes_to_result
     return if @current_file_name.nil?
     @diff_result << operation_description
@@ -143,12 +172,10 @@ class DiffToHtml
     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
+      @diff_lines.each_with_index do |line, index|
+        removals << line if line[:op] == :removal
+        additions << line if line[:op] == :addition
+        if line[:op] == :unchanged || index == @diff_lines.size - 1 # 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
@@ -156,6 +183,10 @@ class DiffToHtml
           end
           removals = []
           additions = []
+          if index > 0 && index != @diff_lines.size - 1
+            prev_line = @diff_lines[index - 1]
+            add_separator unless lines_are_sequential?(prev_line, line)
+          end
           add_line_to_result(line, escape = true) if line[:op] == :unchanged
         end
       end
@@ -179,8 +210,7 @@ class DiffToHtml
     @current_file_name = nil
 
     content.split("\n").each do |line|
-      if line =~ /^diff\s\-\-git/
-        line.match(/diff --git a\/(.*)\sb\//)
+      if line =~ /^diff\s\-\-git\sa\/(.*)\sb\//
         file_name = $1
         add_changes_to_result
         @current_file_name = file_name
@@ -200,7 +230,7 @@ class DiffToHtml
     elsif op == '+'
       @diff_lines << { :added => @right_ln, :removed => nil, :op => :addition, :content => line[1..-1] }
       @right_ln += 1
-    else @right_ln
+    else
       @diff_lines << { :added => @right_ln, :removed => @left_ln, :op => :unchanged, :content => line }
       @right_ln += 1
       @left_ln += 1
@@ -229,7 +259,7 @@ class DiffToHtml
     diff = []
     diff_found = false
     content.split("\n").each do |line|
-      diff_found = true if line =~ /^diff \-\-git/
+      diff_found = true if line =~ /^diff\s\-\-git/
       next unless diff_found
       diff << line
     end
@@ -258,15 +288,14 @@ class DiffToHtml
   end
 
   def message_array_as_html(message)
-    message_map(message.collect { |m| CGI.escapeHTML(m)}.join("<br />"))
+    message_map(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
+    return [$1, $2] if info =~ /^([^\<]+)\s+\<\s*(.*)\s*\>\s*$/ # normal operation
     # incomplete author info - return it as author name
-    return [info, ''] if result.nil?
+    [info, '']
   end
 
   def first_sentence(message_array)
@@ -275,7 +304,48 @@ class DiffToHtml
     msg
   end
 
+  def unique_commits_per_branch?
+    !!@config['unique_commits_per_branch']
+  end
+
+  def get_previous_commits(previous_file)
+    previous_list = []
+    if File.exists?(previous_file)
+      lines = IO.read(previous_file)
+      lines = lines.lines if lines.respond_to?(:lines) # Ruby 1.9 tweak
+      previous_list = lines.to_a.map { |s| s.chomp }.compact.uniq
+      lines = nil
+    end
+    previous_list
+  end
+
+  def check_handled_commits(commits, branch)
+    previous_dir = (!@previous_dir.nil? && File.exists?(@previous_dir)) ? @previous_dir : '/tmp'
+    prefix = unique_commits_per_branch? ? "#{Digest::SHA1.hexdigest(branch)}." : ''
+    previous_name = "#{prefix}#{HANDLED_COMMITS_FILE}"
+    new_name = "#{prefix}#{NEW_HANDLED_COMMITS_FILE}"
+    previous_file = File.join(previous_dir, previous_name)
+    new_file = File.join(previous_dir, new_name)
+
+    previous_list = get_previous_commits(previous_file)
+
+    commits.reject! {|c| c.find { |sha| previous_list.include?(sha) } }
+
+    # if commit list empty there is no need to override list of handled commits
+    flatten_commits = commits.flatten
+    unless flatten_commits.empty?
+      current_list = (previous_list + flatten_commits).last(MAX_COMMITS_PER_ACTION)
+
+      # use new file, unlink and rename to make it more atomic
+      File.open(new_file, 'w') { |f| f << current_list.join("\n") }
+      File.unlink(previous_file) if File.exists?(previous_file)
+      File.rename(new_file, previous_file)
+    end
+    commits
+  end
+
   def diff_between_revisions(rev1, rev2, repo, branch)
+    @branch = branch
     @result = []
     if rev1 == rev2
       commits = [rev1]
@@ -287,42 +357,36 @@ class DiffToHtml
       commits = []
     else
       log = Git.log(rev1, rev2)
-      commits = log.scan(/^commit\s([a-f0-9]+)/).map{|match| match[0]}
+      commits = log.scan(/^commit\s([a-f0-9]+)/).map { |a| a.first }
     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 = check_handled_commits(commits, branch)
 
     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> "
-      
+
       if (@config["link_files"] && @config["link_files"] == "gitweb" && @config["gitweb"])
         title += "<a href='#{@config['gitweb']['path']}?p=#{@config['gitweb']['project']};a=commitdiff;h=#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
       elsif (@config["link_files"] && @config["link_files"] == "gitorious" && @config["gitorious"])
         title += "<a href='#{@config['gitorious']['path']}/#{@config['gitorious']['project']}/#{@config['gitorious']['repository']}/commit/#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
+      elsif (@config["link_files"] && @config["link_files"] == "trac" && @config["trac"])
+        title += "<a href='#{@config['trac']['path']}/#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
+      elsif (@config["link_files"] && @config["link_files"] == "cgit" && @config["cgit"])
+        title += "<a href='#{@config['cgit']['path']}/#{@config['cgit']['project']}/commit/?id=#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
       else
         title += " #{commit_info[:commit]}"
       end
-      
+
       title += "<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>"
@@ -343,14 +407,14 @@ class DiffToHtml
   end
 
   def message_map(message)
-    if @config.include?('message_integration')
+    if @config['message_integration'].respond_to?(:each_pair)
       @config['message_integration'].each_pair do |pm, url|
         pm_def = DiffToHtml::INTEGRATION_MAP[pm.to_sym] or next
         replace_with = pm_def[:replace_with].gsub('#{url}', url)
         message_replace!(message, pm_def[:search_for], replace_with)
       end
     end
-    if @config.include?('message_map')
+    if @config['message_map'].respond_to?(:each_pair)
       @config['message_map'].each_pair do |search_for, replace_with|
         message_replace!(message, Regexp.new(search_for), replace_with)
       end
@@ -379,3 +443,7 @@ class DiffCallback
   end
 
 end
+
+__END__
+
+ vim: tabstop=2:expandtab:shiftwidth=2

data/lib/emailer.rb

@@ -1,23 +1,42 @@
-require 'yaml'
-require 'erb'
 require 'tamtam'
 
 class Emailer
+  DEFAULT_STYLESHEET_PATH = File.join(File.dirname(__FILE__), '/../template/styles.css').freeze
+  TEMPLATE = File.join(File.dirname(__FILE__), '/../template/email.html.erb').freeze
+  PARAMETERS = %w[project_path recipient from_address from_alias subject text_message html_message ref_name old_rev new_rev].freeze
 
-  def initialize(config, project_path, recipient, from_address, from_alias, subject, text_message, html_diff, old_rev, new_rev, ref_name)
+  attr_reader :config
+
+  def initialize(config, options = {})
     @config = config || {}
-    @project_path = project_path
-    @recipient = recipient
-    @from_address = from_address
-    @from_alias = from_alias
-    @subject = subject
-    @text_message = text_message
-    @ref_name = ref_name
-    @old_rev = old_rev
-    @new_rev = new_rev
-
-    template = File.join(File.dirname(__FILE__), '/../template/email.html.erb')
-    @html_message = TamTam.inline(:document => ERB.new(File.read(template)).result(binding))
+    PARAMETERS.each do |name|
+      instance_variable_set("@#{name}".to_sym, options[name.to_sym])
+    end
+  end
+
+  class << self
+    def reset_template
+      @template = nil
+    end
+
+    def template
+      unless @template
+        source = IO.read(TEMPLATE)
+        begin
+          require 'erubis'
+           @template = Erubis::Eruby.new(source)
+        rescue LoadError
+          require 'erb'
+          @template = ERB.new(source)
+        end
+      end
+      @template
+    end
+  end
+
+  def generate_message
+    # TODO: do not use @html, simply return value
+    @html = TamTam.inline(:document => Emailer.template.result(binding))
   end
 
   def boundary
@@ -28,8 +47,8 @@ class Emailer
   end
 
   def stylesheet_string
-    stylesheet = File.join(File.dirname(__FILE__), '/../template/styles.css')
-    File.read(stylesheet)
+    stylesheet = config['stylesheet'] || DEFAULT_STYLESHEET_PATH
+    IO.read(stylesheet)
   end
 
   def perform_delivery_smtp(content, smtp_settings)
@@ -38,12 +57,12 @@ class Emailer
       val = smtp_settings[key].to_s.empty? ? nil : smtp_settings[key]
       settings.merge!({ key => val})
     end
-      
+
     Net::SMTP.start(settings['address'], settings['port'], settings['domain'],
                     settings['user_name'], settings['password'], settings['authentication']) do |smtp|
 
       smtp.enable_tls if settings['enable_tls']
-      
+
       smtp.open_message_stream(@from_address, [@recipient]) do |f|
         content.each do |line|
           f.puts line
@@ -63,13 +82,15 @@ class Emailer
       f.flush
     end
   end
-  
+
   def send
+    generate_message
     from = quote_if_necessary(@from_alias.empty? ? @from_address : "#{@from_alias} <#{@from_address}>", 'utf-8')
     content = ["From: #{from}",
         "Reply-To: #{from}",
         "To: #{quote_if_necessary(@recipient, 'utf-8')}",
         "Subject: #{quote_if_necessary(@subject, 'utf-8')}",
+        "X-Mailer: git-commit-notifier",
         "X-Git-Refname: #{@ref_name}",
         "X-Git-Oldrev: #{@old_rev}",
         "X-Git-Newrev: #{@new_rev}",
@@ -84,7 +105,7 @@ class Emailer
         "Content-Type: text/html; charset=utf-8",
         "Content-Transfer-Encoding: 8bit",
         "Content-Disposition: inline\n\n\n",
-        @html_message,
+        @html,
         "--#{boundary}--"]
 
     if @recipient.empty?
@@ -92,7 +113,7 @@ class Emailer
       return
     end
 
-    if @config['delivery_method'] == 'smtp'
+    if config['delivery_method'] == 'smtp'
       perform_delivery_smtp(content, @config['smtp_server'])
     else
       perform_delivery_sendmail(content, @config['sendmail_options'])

data/lib/git.rb

@@ -1,35 +1,45 @@
 class Git
-  def self.show(rev)
-    `git show #{rev.strip} -w`
-  end
+  class << self
+    def from_shell(cmd)
+      `#{cmd}`
+    end
 
-  def self.log(rev1, rev2)
-    `git log #{rev1}..#{rev2}`.strip
-  end
+    def show(rev)
+      from_shell("git show #{rev.strip} -w")
+    end
 
-  def self.branch_commits(treeish)
-    args = Git.branch_heads - [Git.branch_head(treeish)]
-    args.map! {|tree| "^#{tree}"}
-    args << treeish
-    `git rev-list #{args.join(' ')}`.to_a.map{|commit| commit.chomp}
-  end
+    def log(rev1, rev2)
+      from_shell("git log #{rev1}..#{rev2}").strip
+    end
 
-  def self.branch_heads
-    `git rev-parse --branches`.to_a.map{|head| head.chomp}
-  end
+    def branch_commits(treeish)
+      args = Git.branch_heads - [ Git.branch_head(treeish) ]
+      args.map! { |tree| "^#{tree}" }
+      args << treeish
+      lines = from_shell("git rev-list #{args.join(' ')}")
+      lines = lines.lines if lines.respond_to?(:lines)
+      lines.to_a.map { |commit| commit.chomp }
+    end
 
-  def self.branch_head(treeish)
-    `git rev-parse #{treeish}`.strip
-  end
+    def branch_heads
+      lines = from_shell("git rev-parse --branches")
+      lines = lines.lines if lines.respond_to?(:lines)
+      lines.to_a.map { |head| head.chomp }
+    end
 
-  def self.repo_name
-    git_prefix = `git config hooks.emailprefix`.strip
-    return git_prefix unless git_prefix.empty?
-    dir_name = `pwd`.chomp.split("/").last.gsub(/\.git$/, '')
-    return "#{dir_name}"
-  end
+    def branch_head(treeish)
+      from_shell("git rev-parse #{treeish}").strip
+    end
 
-  def self.mailing_list_address
-    `git config hooks.mailinglist`.strip
+    def repo_name
+      git_prefix = from_shell("git config hooks.emailprefix").strip
+      return git_prefix unless git_prefix.empty?
+      Dir.pwd.split("/").last.sub(/\.git$/, '')
+    end
+
+    def mailing_list_address
+      from_shell("git config hooks.mailinglist").strip
+    end
   end
 end
+