git-commit-notifier 0.8.1 → 0.9.0

data/lib/{emailer.rb → git_commit_notifier/emailer.rb}

@@ -1,8 +1,8 @@
-require 'tamtam'
+require 'premailer'
 
-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
+class GitCommitNotifier::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
 
   attr_reader :config
@@ -34,9 +34,10 @@ class Emailer
     end
   end
 
-  def generate_message
-    # TODO: do not use @html, simply return value
-    @html = TamTam.inline(:document => Emailer.template.result(binding))
+  def mail_html_message
+    html = Emailer.template.result(binding)
+    premailer = Premailer.new(html, :with_html_string => true, :adapter => :nokogiri)
+    premailer.to_inline_css
   end
 
   def boundary
@@ -58,12 +59,14 @@ class Emailer
       settings.merge!({ key => val})
     end
 
-    Net::SMTP.start(settings['address'], settings['port'], settings['domain'],
-                    settings['user_name'], settings['password'], settings['authentication']) do |smtp|
+    main_smtp = Net::SMTP.new settings['address'], settings['port']
 
-      smtp.enable_tls if settings['enable_tls']
+    main_smtp.enable_starttls  if settings['enable_tls']
+    main_smtp.start( settings['domain'],
+                    settings['user_name'], settings['password'], settings['authentication']) do |smtp|
 
-      smtp.open_message_stream(@from_address, [@recipient]) do |f|
+      recp = @recipient.split(",")
+      smtp.open_message_stream(@from_address, recp) do |f|
         content.each do |line|
           f.puts line
         end
@@ -83,30 +86,39 @@ class Emailer
     end
   end
 
+  def perform_delivery_nntp(content, nntp_settings)
+    require 'rubygems'
+    require 'nntp'
+    Net::NNTP.start(nntp_settings['address'], nntp_settings['port']) do |nntp|
+        nntp.post content
+    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}",
-        "Mime-Version: 1.0",
+    to_tag = config['delivery_method'] == 'nntp' ? 'Newsgroups' : 'To'
+    quoted_from_alias = quote_if_necessary("#{@from_alias}",'utf-8')
+    from = @from_alias.empty? ? @from_address : "#{quoted_from_alias} <#{@from_address}>"
+
+    content = ["From: #{from}\n",
+        "#{to_tag}: #{quote_if_necessary(@recipient, 'utf-8')}\n",
+        "Subject: #{quote_if_necessary(@subject, 'utf-8')}\n",
+        "X-Mailer: git-commit-notifier\n",
+        "X-Git-Refname: #{@ref_name}\n",
+        "X-Git-Oldrev: #{@old_rev}\n",
+        "X-Git-Newrev: #{@new_rev}\n",
+        "Mime-Version: 1.0\n",
         "Content-Type: multipart/alternative; boundary=#{boundary}\n\n\n",
-        "--#{boundary}",
-        "Content-Type: text/plain; charset=utf-8",
-        "Content-Transfer-Encoding: 8bit",
+        "--#{boundary}\n",
+        "Content-Type: text/plain; charset=utf-8\n",
+        "Content-Transfer-Encoding: 8bit\n",
         "Content-Disposition: inline\n\n\n",
         @text_message,
-        "--#{boundary}",
-        "Content-Type: text/html; charset=utf-8",
-        "Content-Transfer-Encoding: 8bit",
+        "\n--#{boundary}\n",
+        "Content-Type: text/html; charset=utf-8\n",
+        "Content-Transfer-Encoding: 8bit\n",
         "Content-Disposition: inline\n\n\n",
-        @html,
-        "--#{boundary}--"]
+        mail_html_message,
+        "\n--#{boundary}--"]
 
     if @recipient.empty?
       puts content.join("\n")
@@ -116,7 +128,11 @@ class Emailer
     if config['delivery_method'] == 'smtp'
       perform_delivery_smtp(content, @config['smtp_server'])
     else
-      perform_delivery_sendmail(content, @config['sendmail_options'])
+      if config['delivery_method'] == 'nntp'
+         perform_delivery_nntp(content, @config['nntp_settings'])
+      else
+          perform_delivery_sendmail(content, @config['sendmail_options'])
+      end
     end
   end
 

data/lib/git_commit_notifier/escape_helper.rb

@@ -0,0 +1,5 @@
+module GitCommitNotifier::EscapeHelper
+  def escape_content(s)
+    CGI.escapeHTML(s).gsub(" ", " ")
+  end
+end

data/lib/{git.rb → git_commit_notifier/git.rb}

@@ -1,4 +1,4 @@
-class Git
+class GitCommitNotifier::Git
   class << self
     def from_shell(cmd)
       `#{cmd}`

data/lib/{logger.rb → git_commit_notifier/logger.rb}

@@ -1,6 +1,6 @@
 require 'tmpdir'
 
-class Logger
+class GitCommitNotifier::Logger
   DEFAULT_LOG_DIRECTORY = Dir.tmpdir.freeze
   LOG_NAME = 'git-commit-notifier.log'.freeze
 

data/lib/git_commit_notifier/result_processor.rb

@@ -0,0 +1,131 @@
+require 'cgi'
+
+require 'git_commit_notifier/escape_helper'
+
+module GitCommitNotifier
+  class ResultProcessor
+    include EscapeHelper
+    # input (loaded in @diff) is an array having Hash elements:
+    # { :action => action, :token => string }
+    # action can be :discard_a, :discard_b or :match
+
+    # output: two formatted html strings, one for the removals and one for the additions
+
+    def results
+      close_tags # close last tag
+      [array_of_lines(@result[:removal]), array_of_lines(@result[:addition])]
+    end
+
+    def length_in_chars(diff)
+      diff.inject(0) do |length, s|
+        token = s[:token]
+        token_length = token.respond_to?(:jlength) ? token.jlength : token.length
+        length + token_length
+      end
+    end
+
+    private
+
+    def initialize(diff)
+      @diff = diff
+      init
+      filter_replaced_lines
+      process
+    end
+
+    def init
+      @result = { :addition => [], :removal => [] }
+      @tag_open = { :addition => false, :removal => false}
+    end
+
+    def process
+      @highlight = !@diff.select { |d| d[:action] == :match}.empty? # highlight only if block contains both matches and differences
+      @diff.each do |diff|
+        case diff[:action]
+        when :match
+          match(diff)
+        when :discard_a
+          discard_a(diff)
+        when :discard_b
+          discard_b(diff)
+        end
+      end
+    end
+
+    def discard_match(position, token)
+      # replace it with 2 changes
+      @diff[position][:action] = :discard_a
+      @diff.insert(position, { :action => :discard_b, :token => token} )
+    end
+
+    def filter_replaced_lines
+      # if a block is replaced by an other one, lcs-diff will find even the single common word between the old and the new content
+      # no need for intelligent diff in this case, simply show the removed and the added block with no highlighting
+      # rule: if less than 33% of a block is not a match, we don't need intelligent diff for that block
+      match_length = length_in_chars(@diff.select { |d| d[:action] == :match })
+      total_length = length_in_chars(@diff)
+
+      if total_length.to_f / match_length > 3.3
+        @diff.each_with_index do |d, i|
+          next if d[:action] != :match
+          discard_match(i, d[:token])
+        end
+      end
+    end
+
+    def match(diff)
+      close_tags
+      all_actions do |action|
+        close_last_tag(diff)
+        @result[action] << escape_content(diff[:token])
+      end
+    end
+
+    def discard_a(diff)
+      open_tag(:removal, diff[:token])
+      close_last_tag(diff)
+      @result[:removal] << escape_content(diff[:token])
+    end
+
+    def discard_b(diff)
+      open_tag(:addition, diff[:token])
+      close_last_tag(diff)
+      @result[:addition] << escape_content(diff[:token])
+    end
+
+    def all_actions
+      [:addition, :removal].each do |action|
+        yield(action)
+      end
+    end
+
+    def open_tag(action, next_token)
+      return if !@highlight || next_token.strip.empty?  # don't open span tag if no highlighting is needed or the first token is empty
+      unless @tag_open[action]
+        klass = action == :addition ? 'aa' : 'rr'
+        @result[action] << "<span class=\"#{klass}\">"
+        @tag_open[action] = true
+      end
+    end
+
+    def close_tags
+      return unless @highlight
+      all_actions do |action|
+        if @tag_open[action]
+          @result[action] << "</span>"
+          @tag_open[action] = false
+        end
+      end
+    end
+
+    def close_last_tag(diff)
+      return unless @highlight
+      close_tags if diff[:token] == "\n"
+    end
+
+    def array_of_lines(tokens)
+      tokens.join('').split("\n")
+    end
+
+  end
+end

data/spec/fixtures/git-notifier-with-branch-restrictions.yml

@@ -0,0 +1,22 @@
+delivery_method: sendmail # smtp or sendmail
+ignore_merge: true # set to true if you want to ignore empty merge messages
+
+# defines what branches to email for
+include_branches: [master, branch2]
+
+
+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/spec/lib/{commit_hook_spec.rb → git_commit_notifier/commit_hook_spec.rb}

@@ -1,5 +1,7 @@
-require File.expand_path('../../spec_helper', __FILE__)
-require 'commit_hook'
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'git_commit_notifier'
+
+include GitCommitNotifier
 
 describe CommitHook do
 
@@ -18,17 +20,46 @@ describe CommitHook do
     run_with_config('spec/fixtures/git-notifier-group-email-by-push.yml', 1)
   end
 
-  def run_with_config(config, times)
+  it "should ignore commits to non specified branches if branch limits supplied" do
+    # 4 commits, one email for each of them, without merge
+    run_and_reject('spec/fixtures/git-notifier-with-branch-restrictions.yml',0,'refs/heads/branchx')
+  end
+
+  it "should email for commits to branch in include_branch" do
+    # 4 commits, one email for each of them, without merge
+    run_with_config('spec/fixtures/git-notifier-with-branch-restrictions.yml',4,'refs/heads/branch2')
+  end
+  
+
+  it "should email for commits to master if master set as include_branch" do
+    # 4 commits, one email for each of them, without merge
+    run_with_config('spec/fixtures/git-notifier-with-branch-restrictions.yml',4)
+  end
+  
+  
+  def run_with_config(config, times, branch = 'refs/heads/master')
     expect_repository_access
 
     emailer = mock!.send.times(times).subject
     mock(Emailer).new(anything, anything) { emailer }.times(times)
-
     mock(CommitHook).info(/Sending mail/)
 
-    any_instance_of(DiffToHtml, :check_handled_commits => lambda { |commits, branch| commits })
-    CommitHook.run config, REVISIONS.first, REVISIONS.last, 'refs/heads/master'
+    any_instance_of(DiffToHtml, :check_handled_commits => lambda { |commits| commits })
+    CommitHook.run config, REVISIONS.first, REVISIONS.last, branch
   end
+  
+
+  def run_and_reject(config,times,branch)
+    mock(Git).mailing_list_address { 'recipient@test.com' }
+
+    emailer = mock!.send.times(times).subject
+    mock(Emailer).new(anything, anything).times(times)
+
+    mock(CommitHook).info(/Supressing mail for branch/)
+
+    CommitHook.run config, REVISIONS.first, REVISIONS.last, branch
+  end
+  
 
   def test_commit_from
     # 1 commit with a from: adress
@@ -81,8 +112,3 @@ describe CommitHook do
   end
 
 end
-
-__END__
-
- vim: tabstop=2 expandtab shiftwidth=2
-

data/spec/lib/{diff_to_html_spec.rb → git_commit_notifier/diff_to_html_spec.rb}

@@ -1,11 +1,11 @@
-require File.expand_path('../../spec_helper', __FILE__)
-require 'diff_to_html'
-require 'git'
-require 'hpricot'
-
-describe DiffToHtml do
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'nokogiri'
+require 'git_commit_notifier'
 
+include GitCommitNotifier
 
+describe DiffToHtml do
+  
   describe :lines_are_sequential? do
     before(:all) do
       @diff_to_html = DiffToHtml.new
@@ -106,7 +106,7 @@ describe DiffToHtml do
     end
 
     diff = DiffToHtml.new
-    mock(diff).check_handled_commits(anything, 'master') { |commits, branch| commits }
+    mock(diff).check_handled_commits(anything) { |commits| commits }
     diff.diff_between_revisions REVISIONS.first, REVISIONS.last, 'testproject', 'master'
 
     diff.result.should have(5).commits # one result for each of the commits
@@ -116,9 +116,9 @@ describe DiffToHtml do
     end
 
     # first commit
-    hp = Hpricot diff.result.first[:html_content]
+    hp = Nokogiri::HTML diff.result.first[:html_content]
     (hp/"table").should have(2).tables # 2 files updated - one table for each of the files
-    (hp/"table/tr/").each do |td|
+    (hp/"table"/"tr"/"td").each do |td|
       if td.inner_html == "require 'iconv'"
         # first added line in changeset a4629e707d80a5769f7a71ca6ed9471015e14dc9
         td.parent.search('td')[0].inner_text.should == '' # left
@@ -128,11 +128,11 @@ describe DiffToHtml do
     end
 
     # second commit
-    hp = Hpricot diff.result[1][:html_content]
+    hp = Nokogiri::HTML diff.result[1][:html_content]
     (hp/"table").should have(1).table # 1 file updated
 
     # third commit - dce6ade4cdc2833b53bd600ef10f9bce83c7102d
-    hp = Hpricot diff.result[2][:html_content]
+    hp = Nokogiri::HTML diff.result[2][:html_content]
     (hp/"table").should have(6).tables # 6 files updated
     (hp/"h2")[1].inner_text.should == 'Added binary file railties/doc/guides/source/images/icons/callouts/11.png'
     (hp/"h2")[2].inner_text.should == 'Deleted binary file railties/doc/guides/source/icons/up.png'
@@ -140,9 +140,9 @@ describe DiffToHtml do
     (hp/"h2")[4].inner_text.should == 'Added file railties/doc/guides/source/images/icons/README'
 
     # fourth commit - 51b986619d88f7ba98be7d271188785cbbb541a0
-    hp = Hpricot diff.result[3][:html_content]
+    hp = Nokogiri::HTML diff.result[3][:html_content]
     (hp/"table").should have(3).tables # 3 files updated
-    (hp/"table/tr/").each do |td|
+    (hp/"table"/"tr"/"td").each do |td|
       if td.inner_html =~ /create_btn/
         cols = td.parent.search('td')
         ['405', '408', ''].should be_include(cols[0].inner_text) # line 405 changed
@@ -157,12 +157,90 @@ describe DiffToHtml do
       mock(Git).show(rev) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
     end
     diff = DiffToHtml.new
-    mock(diff).check_handled_commits(anything, 'rvm') { |commits, branch| commits }
+    mock(diff).check_handled_commits(anything) { |commits| commits }
     diff.diff_between_revisions(first_rev, last_rev, 'tm-admin', 'rvm')
     diff.result.should have(1).commit
-    hp = Hpricot diff.result.first[:html_content]
+    hp = Nokogiri::HTML diff.result.first[:html_content]
     (hp/"table").should have(1).table
     (hp/"tr.r").should have(1).row
   end
-end
 
+  describe :message_map do
+    before(:each) do
+      @diff = DiffToHtml.new
+    end
+
+    it "should do message mapping" do
+      stub(@diff).do_message_integration("msg") { "msg2" }
+      mock(@diff).do_message_map("msg2") { "msg3" }
+      @diff.message_map("msg").should == "msg3"
+    end
+
+    it "should do message integration" do
+      mock(@diff).do_message_integration("msg") { "msg2" }
+      stub(@diff).do_message_map("msg2") { "msg3" }
+      @diff.message_map("msg").should == "msg3"
+    end
+  end
+
+  describe :do_message_integration do
+    before(:each) do
+      @config = Hash.new
+      @diff = DiffToHtml.new(nil, @config)
+    end
+=begin
+    return message unless @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]
+      replace_with = replace_with.kind_of?(Proc) ? lambda { |m| pm_def[:replace_with].call(m, url) } : replace_with.gsub('#{url}', url)
+      message_replace!(message, pm_def[:search_for], replace_with)
+    end
+    message
+=end
+    it "should do nothing unless message_integration config section exists" do
+      mock.proxy(nil).respond_to?(:each_pair)
+      dont_allow(@diff).message_replace!
+      @diff.do_message_integration('yu').should == 'yu'
+    end
+    it "should pass MESSAGE_INTEGRATION through message_replace!" do
+      @config['message_integration'] = {
+        'mediawiki' => 'http://example.com/wiki', # will rework [[text]] to MediaWiki pages
+        'redmine' => 'http://redmine.example.com' # will rework refs #123, #125 to Redmine issues
+      }
+      @diff.do_message_integration("[[text]] refs #123, #125").should == "<a href=\"http://example.com/wiki/text\">[[text]]</a> refs <a href=\"http://redmine.example.com/issues/show/123\">#123</a>, <a href=\"http://redmine.example.com/issues/show/125\">#125</a>"
+    end
+  end
+
+  describe :old_commit? do
+    before(:each) do
+      @config = Hash.new
+      @diff_to_html = DiffToHtml.new(nil, @config)
+    end
+
+    it "should be false unless skip_commits_older_than set" do
+      @diff_to_html.old_commit?(Hash.new).should be_false
+    end
+
+    it "should be false if skip_commits_older_than less than zero" do
+      @config['skip_commits_older_than'] = '-7'
+      @diff_to_html.old_commit?(Hash.new).should be_false
+    end
+
+    it "should be false if skip_commits_older_than is equal to zero" do
+      @config['skip_commits_older_than'] = 0
+      @diff_to_html.old_commit?(Hash.new).should be_false
+    end
+
+    it "should be false if commit is newer than required by skip_commits_older_than" do
+      @config['skip_commits_older_than'] = 1
+      @diff_to_html.old_commit?({:date => (Time.now - 1).to_s}).should be_false
+    end
+
+    it "should be true if commit is older than required by skip_commits_older_than" do
+      @config['skip_commits_older_than'] = 1
+      @diff_to_html.old_commit?({:date => (Time.now - 2 * DiffToHtml::SECS_PER_DAY).to_s}).should be_true
+    end
+  end
+
+end