git-commit-notifier 0.7.2 → 0.8.0

data/README.textile

@@ -44,6 +44,29 @@ git-commit-notifier path_to_config.yml
 
 An example for the config file can be found in <a href="http://github.com/bitboxer/git-commit-notifier/blob/master/config/git-notifier-config.yml.sample">config/git-notifier-config.yml.sample</a>.
 
+h2. Integration with Redmine, Bugzilla, MediaWiki
+
+Git-commit-notifier supports easy integration with Redmine, Bugzilla and MediaWiki. All you need is to uncomment the according line in the configuration and change the links to your software installations instead of example ones (no trailing slash please).
+
+* "BUG 123" sentence in commit message will be replaced with link to bug in Bugzilla.
+* "refs #123" and "fixes #123" sentences in commit message will be replaced with link to issue in Redmine.
+* "[[SomePage]]" sentence in commit message will be replaced with link to page in MediaWiki.
+
+h2. Integration of links to other websites
+
+If you need integration with other websites not supported by git-commit-notifier you can use the message_map property. For that you need to know basics of regular expressions syntax.
+
+Each key of message_map is a case sensitive Regexp pattern, and its value is the replacement string. 
+Every matched group (that defined by round brackets in regular expression) will be automatically substituted instead of \1-\9 backreferences in replacement string where number after backslash informs which group should be substituted instead of the backreference. The first matched group is known as \1.
+
+For example, when we need to expand "follow 23" to http://example.com/answer/23, simply type this:
+
+'\bfollow\s+(\d+)': 'http://example.com/answer/\1'
+
+Key and value are enclosed into single quotes. \b means that "follow" must not be preceded by other word chars, so "befollow" will not match but "be follow" will match. After "follow" we expect one or more spaces followed by group of one or more digits. The \1 in the result url will be replaced with the matched group.
+
+More examples can be found in the config file.
+
 h2. Note on Patches/Pull Requests
  
 * Fork the project.
@@ -54,6 +77,15 @@ h2. Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+h2. Troubleshooting
+
+h3. Permission denied - /var/git/repo/previously.txt (Errno::EACCES)
+
+The file __previously.txt__ is created at the first commit. If you moved the file to the server, you have to check the rights to that file and fix them if needed.
+
+<pre>sudo touch /var/git/repo/previously.txt
+sudo chmod a+x /var/git/repo/previously.txt</pre>
+
 h2. License
 
 MIT License, see the file LICENSE.

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.8.0

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

@@ -7,12 +7,18 @@ ignore_merge: false
 # Optional parameter for the subject-line of the mail 
 # emailprefix: GIT
 
-# Decorate files with link to a webview. Possible values: none or gitweb
+# Decorate files with link to a webview. Possible values: none, gitweb or gitorious
 link_files: none 
 
+# Limit lines per diff
+# lines_per_diff: 300
+
 # select the delivery method: smtp or sendmail 
 delivery_method: sendmail 
 
+# Optionally group email by push: don't send an email for each commit when true.
+# group_email_by_push: false
+
 # settings for the smtp server
 smtp_server:
   address: localhost
@@ -28,8 +34,26 @@ sendmail_options:
   location: /usr/sbin/sendmail
   arguments: -i -t
 
+# commit message URL map
+message_map:
+#  '\brefs\s*\#(\d+)': 'http://example.com/redmine/issues/show/\1'
+
+# Uncomment if you want to create links in your commit text
+message_integration:
+#  mediawiki: http://example.com/wiki # will rework [[text]] to MediaWiki pages
+#  redmine: http://redmine.example.com # will rework refs #123 to Redmine issues
+#  bugzilla: http://bz.example.com # will rework BUG 123 to Bugzilla bugs
+
 # If link_files is set to "gitweb", you need to configure the path to your gitweb
 # instance and the project name.
 gitweb:
   path: http://developerserver/path_to_gitweb
-  project: test.git
+  project: test.git
+
+# If link_files is set to "gitorious", you need to configure the path to your gitorious
+# instance, the project name and the repository name.
+gitorious:
+  path: http://example.com/path_to_gitorious
+  project: backend
+  repository: sql-scripts
+

data/git-commit-notifier.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git-commit-notifier}
-  s.version = "0.7.2"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bodo Tasche"]
-  s.date = %q{2010-05-08}
+  s.date = %q{2010-08-06}
   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}
@@ -35,6 +35,8 @@ Gem::Specification.new do |s|
      "lib/result_processor.rb",
      "template/email.html.erb",
      "template/styles.css",
+     "test/fixtures/existing_file_one_line.txt",
+     "test/fixtures/git-notifier-group-email-by-push.yml",
      "test/fixtures/git-notifier-ignore-merge.yml",
      "test/fixtures/git-notifier-with-merge.yml",
      "test/fixtures/git_log",
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
      "test/fixtures/git_show_a4629e707d80a5769f7a71ca6ed9471015e14dc9",
      "test/fixtures/git_show_dce6ade4cdc2833b53bd600ef10f9bce83c7102d",
      "test/fixtures/git_show_e28ad77bba0574241e6eb64dfd0c1291b221effe",
+     "test/fixtures/new_file_one_line.txt",
      "test/test_helper.rb",
      "test/unit/test_commit_hook.rb",
      "test/unit/test_diff_to_html.rb",
@@ -51,7 +54,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{Sends git commit messages with diffs}
   s.test_files = [
     "test/test_helper.rb",
@@ -64,7 +67,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= 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"])

data/lib/commit_hook.rb

@@ -47,12 +47,46 @@ class CommitHook
         !result[:commit_info][:merge].nil?
       }
     end
-    
-    diffresult.reverse.each_with_index do |result, i|
-      nr = number(diffresult.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
+
+    if (@config["group_email_by_push"])
+      text, html = [], []
+      diffresult.each_with_index do |result, i|
+        text << result[:text_content]
+        html << result[:html_content]
+      end
+      result = diffresult.first
+      emailer = Emailer.new(
+        @config,
+        project_path,
+        recipient,
+        result[:commit_info][:email],
+        result[:commit_info][:author],
+        "[#{prefix}#{branch_name}] #{diffresult.size > 1 ? "#{diffresult.size} commits: " : ''}#{result[:commit_info][:message]}",
+        text.join("------------------------------------------\n\n"),
+        html.join("<hr /><br />"),
+        rev1,
+        rev2,
+        ref_name
+      )
       emailer.send
+    else
+      diffresult.reverse.each_with_index do |result, i|
+        nr = number(diffresult.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
   end
 

data/lib/diff_to_html.rb

@@ -7,19 +7,24 @@ def escape_content(s)
 end
 
 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' }
+  }.freeze
+  
   attr_accessor :file_prefix, :current_file_name
   attr_reader :result
 
   def initialize(previous_dir = nil, config = nil)
     @previous_dir = previous_dir
     @config = config || {}
+    @lines_added = 0
   end
 
   def range_info(range)
-    range.match(/^@@ \-(\d+),\d+ \+(\d+),\d+ @@/)
-    left_ln = Integer($1)
-    right_ln = Integer($2)
-    return left_ln, right_ln
+    matches = range.match(/^@@ \-(\S+) \+(\S+)/)
+    return matches[1..2].map { |m| m.split(',')[0].to_i }
   end
 
   def line_class(line)
@@ -40,6 +45,16 @@ class DiffToHtml
   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>'
+      end
+      if @lines_added >= lines_per_diff
+        return
+      end
+    end
     klass = line_class(line)
     content = escape ? escape_content(line[:content]) : line[:content]
     padding = '&nbsp;' if klass != ''
@@ -113,6 +128,8 @@ class DiffToHtml
     
     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>"
     end
     
     header = "#{op} #{binary}file #{file_name}"
@@ -241,7 +258,7 @@ class DiffToHtml
   end
 
   def message_array_as_html(message)
-    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)
@@ -298,6 +315,8 @@ class DiffToHtml
       
       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>"
       else
         title += " #{commit_info[:commit]}"
       end
@@ -317,6 +336,27 @@ class DiffToHtml
       @result << {:commit_info => commit_info, :html_content => html, :text_content => text }
     end
   end
+
+  def message_replace!(message, search_for, replace_with)
+    full_replace_with = "<a href=\"#{replace_with}\">\\0</a>"
+    message.gsub!(Regexp.new(search_for), full_replace_with)
+  end
+
+  def message_map(message)
+    if @config.include?('message_integration')
+      @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')
+      @config['message_map'].each_pair do |search_for, replace_with|
+        message_replace!(message, Regexp.new(search_for), replace_with)
+      end
+    end
+    message
+  end
 end
 
 class DiffCallback

data/lib/emailer.rb

@@ -63,13 +63,13 @@ class Emailer
       f.flush
     end
   end
-
+  
   def send
-    from = @from_alias.empty? ? @from_address : "#{@from_alias} <#{@from_address}>"
+    from = quote_if_necessary(@from_alias.empty? ? @from_address : "#{@from_alias} <#{@from_address}>", 'utf-8')
     content = ["From: #{from}",
         "Reply-To: #{from}",
-        "To: #{@recipient}",
-        "Subject: #{@subject}",
+        "To: #{quote_if_necessary(@recipient, 'utf-8')}",
+        "Subject: #{quote_if_necessary(@subject, 'utf-8')}",
         "X-Git-Refname: #{@ref_name}",
         "X-Git-Oldrev: #{@old_rev}",
         "X-Git-Newrev: #{@new_rev}",
@@ -99,4 +99,33 @@ class Emailer
     end
   end
 
+  # Convert the given text into quoted printable format, with an instruction
+  # that the text be eventually interpreted in the given charset.
+  def quoted_printable(text, charset)
+    text = text.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }.
+                gsub( / /, "_" )
+    "=?#{charset}?Q?#{text}?="
+  end
+
+  # Convert the given character to quoted printable format, taking into
+  # account multi-byte characters (if executing with $KCODE="u", for instance)
+  def quoted_printable_encode(character)
+    result = ""
+    character.each_byte { |b| result << "=%02X" % b }
+    result
+  end
+
+  # A quick-and-dirty regexp for determining whether a string contains any
+  # characters that need escaping.
+  CHARS_NEEDING_QUOTING = /[\000-\011\013\014\016-\037\177-\377]/
+
+  # Quote the given text if it contains any "illegal" characters
+  def quote_if_necessary(text, charset)
+    text = text.dup.force_encoding(Encoding::ASCII_8BIT) if text.respond_to?(:force_encoding)
+
+    (text =~ CHARS_NEEDING_QUOTING) ?
+      quoted_printable(text, charset) :
+      text
+  end
 end
+

data/test/fixtures/existing_file_one_line.txt

@@ -0,0 +1,9 @@
+diff --git a/readme b/readme
+index d0c7fbe..f762684 100644
+--- a/readme
++++ b/readme
+@@ -2,3 +2,4 @@ test
+ test
+ test
+ test
++test

data/test/fixtures/git-notifier-group-email-by-push.yml

@@ -0,0 +1,19 @@
+delivery_method: sendmail # smtp or sendmail
+ignore_merge: false # set to true if you want to ignore empty merge messages
+
+group_email_by_push: true
+
+smtp_server:
+  address: localhost
+  port: 25
+  domain: localhost
+  user_name: user@localhost
+  password: password
+  authentication: plain
+  enable_tls: false
+
+sendmail_options:
+  location: /usr/sbin/sendmail
+  arguments:
+
+

data/test/fixtures/new_file_one_line.txt

@@ -0,0 +1,6 @@
+diff --git a/readme b/readme
+index e69de29..9daeafb 100644
+--- a/readme
++++ b/readme
+@@ -0,0 +1 @@
++test

data/test/unit/test_commit_hook.rb

@@ -8,25 +8,36 @@ require File.dirname(__FILE__) + '/../../lib/git'
 class CommitHookTest < Test::Unit::TestCase
 
   def test_hook_ignore_merge
-    run_with_config('test/fixtures/git-notifier-ignore-merge.yml', 4) # 4 commit, one email for each of them, without merge
+    # 4 commits, one email for each of them, without merge
+    run_with_config('test/fixtures/git-notifier-ignore-merge.yml', 4)
   end
 
   def test_hook_with_merge
-    run_with_config('test/fixtures/git-notifier-with-merge.yml', 5) # 5 commit, one email for each of them, with merge mail
+    # 5 commits, one email for each of them, with merge mail
+    run_with_config('test/fixtures/git-notifier-with-merge.yml', 5)
+  end
+
+  def test_hook_group_email_by_push
+    # 1 commit for the push, all commits in the one message
+    run_with_config('test/fixtures/git-notifier-group-email-by-push.yml', 1)
   end
 
   def run_with_config(config, times)
+    expect_repository_access
+
+    emailer = mock('Emailer')
+    Emailer.expects(:new).times(times).returns(emailer)
+    emailer.expects(:send).times(times)
+    CommitHook.run config, REVISIONS.first, REVISIONS.last, 'refs/heads/master'
+  end
+
+  def expect_repository_access
     path = File.dirname(__FILE__) + '/../fixtures/'
     Git.expects(:log).with(REVISIONS.first, REVISIONS.last).returns(read_file(path + 'git_log'))
     Git.expects(:mailing_list_address).returns('recipient@test.com')
     REVISIONS.each do |rev|
       Git.expects(:show).with(rev).returns(read_file(path + "git_show_#{rev}"))
     end
-    emailer = mock('Emailer')
-    Emailer.expects(:new).times(times).returns(emailer) # 4 commit, one email for each of them
-    emailer.expects(:send).times(times)
-    CommitHook.run config, REVISIONS.first, REVISIONS.last, 'refs/heads/master'
   end
 
-
 end

data/test/unit/test_diff_to_html.rb

@@ -94,7 +94,7 @@ class DiffToHtmlTest < Test::Unit::TestCase
               'key',',',' ','scope'], tokens
   end
 
-  def test_operation_description
+  def test_gitweb_operation_description
     diff = DiffToHtml.new
     diff.current_file_name = "file/to/test.yml"
     assert_equal "<h2>Changed file file/to/test.yml</h2>\n", diff.operation_description
@@ -110,7 +110,51 @@ class DiffToHtmlTest < Test::Unit::TestCase
     diff = DiffToHtml.new(nil, config)
     diff.current_file_name = "file/to/test.yml"
     assert_equal "<h2>Changed file <a href='http://developerserver/path_to_gitweb?p=test.git;f=file/to/test.yml;hb=HEAD'>file/to/test.yml</a></h2>\n", diff.operation_description
+  end
+
+  def test_gitorious_operation_description
+    diff = DiffToHtml.new
+    diff.current_file_name = "file/to/test.yml"
+    assert_equal "<h2>Changed file file/to/test.yml</h2>\n", diff.operation_description
+
+    config = {
+      "link_files" => "gitorious",
+      "gitorious" => {
+        "path" => "http://example.com/gitorious", 
+        "project" => "tests",
+        "repository" => "test",
+      }
+    }
 
+    diff = DiffToHtml.new(nil, config)
+    diff.current_file_name = "file/to/test.yml"
+    assert_equal "<h2>Changed file <a href='http://example.com/gitorious/tests/test/blobs/HEAD/file/to/test.yml'>file/to/test.yml</a></h2>\n", diff.operation_description
+  end
+
+  def test_should_correctly_set_line_numbers_on_single_line_add_to_new_file
+    diff = DiffToHtml.new
+    diff.expects(:add_line_to_result).with() { |line, escape| line[:added] == 1 }
+    content = IO.read('test/fixtures/new_file_one_line.txt')
+    result = diff.diff_for_revision(content)
   end
 
+  def test_should_correctly_set_line_numbers_on_single_line_add_to_existing_file
+    diff = DiffToHtml.new
+    diff.expects(:add_line_to_result).at_least_once
+    diff.expects(:add_line_to_result).at_least_once.with() { |line, escape| line[:added] == 5 && line[:removed] == nil }
+    content = IO.read('test/fixtures/existing_file_one_line.txt')
+    result = diff.diff_for_revision(content)
+  end
+
+  def test_message_map_should_correctly_rework_message
+    diff = DiffToHtml.new(nil, 'message_map' => {
+      '\brefs\s*\#(\d+)' => 'http://redmine.example.com/issues/show/\1'
+    }, 'message_integration' => {
+      'bugzilla' => 'http://bugzilla.example.com'
+    })
+    assert_equal(
+      '<a href="http://bugzilla.example.com/show_bug.cgi?id=15">BUG 15</a>. Draft design <a href="http://redmine.example.com/issues/show/5654">refs #5654</a>', 
+      diff.message_map('BUG 15. Draft design refs #5654')
+    )
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-commit-notifier
 version: !ruby/object:Gem::Version 
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 2
-  version: 0.7.2
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Bodo Tasche
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-08 00:00:00 +02:00
+date: 2010-08-06 00:00:00 +02:00
 default_executable: git-commit-notifier
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: hpricot
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +64,11 @@ dependencies:
   name: tamtam
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -91,6 +100,8 @@ files:
 - lib/result_processor.rb
 - template/email.html.erb
 - template/styles.css
+- test/fixtures/existing_file_one_line.txt
+- test/fixtures/git-notifier-group-email-by-push.yml
 - test/fixtures/git-notifier-ignore-merge.yml
 - test/fixtures/git-notifier-with-merge.yml
 - test/fixtures/git_log
@@ -99,6 +110,7 @@ files:
 - test/fixtures/git_show_a4629e707d80a5769f7a71ca6ed9471015e14dc9
 - test/fixtures/git_show_dce6ade4cdc2833b53bd600ef10f9bce83c7102d
 - test/fixtures/git_show_e28ad77bba0574241e6eb64dfd0c1291b221effe
+- test/fixtures/new_file_one_line.txt
 - test/test_helper.rb
 - test/unit/test_commit_hook.rb
 - test/unit/test_diff_to_html.rb
@@ -113,23 +125,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Sends git commit messages with diffs