git-commit-notifier 0.8.0 → 0.8.1

data/lib/logger.rb

@@ -0,0 +1,48 @@
+require 'tmpdir'
+
+class Logger
+  DEFAULT_LOG_DIRECTORY = Dir.tmpdir.freeze
+  LOG_NAME = 'git-commit-notifier.log'.freeze
+
+  attr_reader :log_directory
+
+  def initialize(config)
+    @enabled = !!(config['debug'] && config['debug']['enabled'])
+    @log_directory = debug? ? (config['debug']['log_directory'] || DEFAULT_LOG_DIRECTORY) : nil
+  end
+
+  def debug?
+    @enabled
+  end
+
+  def log_path
+    return nil unless debug?
+    File.join(log_directory, LOG_NAME)
+  end
+
+  def debug(msg)
+    return unless debug?
+    File.open(log_path, 'a') do |f|
+      f.puts msg
+    end
+  end
+
+  def file(file_path)
+    return unless debug?
+    orig_dest_name = File.join(log_directory, File.basename(file_path))
+    dest_name = orig_dest_name
+    counter = 1
+    while File.exists?(dest_name)
+      counter += 1
+      dest_name = "#{orig_dest_name}.#{counter}"
+    end
+    debug("Save file #{file_path} for debugging purposes to #{dest_name}")
+    File.copy(file_path, dest_name)
+  end
+
+end
+
+__END__
+
+ vim: tabstop=2:expandtab:shiftwidth=2
+

data/lib/result_processor.rb

@@ -12,6 +12,14 @@ class ResultProcessor
     [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)
@@ -46,15 +54,11 @@ class ResultProcessor
     @diff.insert(position, { :action => :discard_b, :token => token} )
   end
 
-  def length_in_chars(diff)
-    diff.inject(0) { |length, s| length + s[:token].size}
-  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})
+    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

data/{test → spec}/fixtures/git-notifier-group-email-by-push.yml

@@ -1,6 +1,8 @@
 delivery_method: sendmail # smtp or sendmail
 ignore_merge: false # set to true if you want to ignore empty merge messages
 
+from: max@example.com
+
 group_email_by_push: true
 
 smtp_server:

data/spec/fixtures/git_show_ff037a73fc1094455e7bbf506171a3f3cf873ae6

@@ -0,0 +1,18 @@
+commit ff037a73fc1094455e7bbf506171a3f3cf873ae6
+Author: Mokevnin Kirill <mokevnin@gmail.com>
+Date:   Tue Oct 26 15:31:13 2010 +0400
+
+    remove debug put
+
+diff --git a/app/models/user.rb b/app/models/user.rb
+index ac9399f..ea2e351 100644
+--- a/app/models/user.rb
++++ b/app/models/user.rb
+@@ -226,7 +226,6 @@ class User < ActiveRecord::Base
+     all_stats.keys.each do |type|
+       all_stats[type].each do |st|
+         stat_line = {type => st[:value]}
+-        puts "type #{type} st #{st}"
+         if results[st[:shift]]
+           results[st[:shift]].merge!(stat_line)
+         else

data/spec/lib/commit_hook_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'commit_hook'
+
+describe CommitHook do
+
+  it "should ignore merge" do
+    # 4 commits, one email for each of them, without merge
+    run_with_config('spec/fixtures/git-notifier-ignore-merge.yml', 4)
+  end
+
+  it "should hook with merge" do
+    # 5 commits, one email for each of them, with merge mail
+    run_with_config('spec/fixtures/git-notifier-with-merge.yml', 5)
+  end
+
+  it "should hook group email by push" do
+    # 1 commit for the push, all commits in the one message
+    run_with_config('spec/fixtures/git-notifier-group-email-by-push.yml', 1)
+  end
+
+  def run_with_config(config, times)
+    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'
+  end
+
+  def test_commit_from
+    # 1 commit with a from: adress
+    expect_repository_access
+    emailer = mock!.send.subject
+    mock(Emailer).new(anything, hash_including(:from_address => "max@example.com")) { emailer }
+
+    CommitHook.run 'spec/fixtures/git-notifier-group-email-by-push.yml', REVISIONS.first, REVISIONS.last, 'refs/heads/master'
+   end
+
+  def expect_repository_access
+    mock(Git).log(REVISIONS.first, REVISIONS.last) { IO.read(FIXTURES_PATH + 'git_log') }
+    mock(Git).mailing_list_address { 'recipient@test.com' }
+    REVISIONS.each do |rev|
+      mock(Git).show(rev) { IO.read(FIXTURES_PATH + "git_show_#{rev}") }
+    end
+  end
+
+  describe :logger do
+    it "should be nstance of logger" do
+      stub(CommitHook).config { {} }
+      CommitHook.logger.should be_kind_of(Logger)
+    end
+  end
+
+  describe :show_error do
+    it "should write error to stderr" do
+      mock($stderr).puts("\n").times(2)
+      mock($stderr).puts(/GIT\sNOTIFIER\sPROBLEM/).times(2)
+      mock($stderr).puts('yes')
+      CommitHook.show_error('yes')
+    end
+  end
+
+  describe :info do
+    it "should write to and flush stdout" do
+      mock($stdout).puts('msg')
+      mock($stdout).flush
+      CommitHook.info('msg')
+    end
+  end
+
+  describe :run do
+    it "should report error when no recipients specified" do
+      mock(File).exists?(:noconfig) { false }
+      mock(Git).mailing_list_address { nil }
+      mock(CommitHook).show_error(/recipient/)
+      CommitHook.run(:noconfig, :rev1, :rev2, 'master')
+    end
+  end
+
+end
+
+__END__
+
+ vim: tabstop=2 expandtab shiftwidth=2
+

data/spec/lib/diff_to_html_spec.rb

@@ -0,0 +1,168 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'diff_to_html'
+require 'git'
+require 'hpricot'
+
+describe DiffToHtml do
+
+
+  describe :lines_are_sequential? do
+    before(:all) do
+      @diff_to_html = DiffToHtml.new
+    end
+
+    it "should be true if left line numbers are sequential" do
+      @diff_to_html.lines_are_sequential?({
+        :added => 2,
+        :removed => 2
+      }, {
+        :added => 3,
+        :removed => 6
+      }).should be_true
+    end
+
+    it "should be true if right line numbers are sequential" do
+      @diff_to_html.lines_are_sequential?({
+        :added => 2,
+        :removed => 2
+      }, {
+        :added => 7,
+        :removed => 3
+      }).should be_true
+    end
+
+    it "should be false unless line numbers are sequential" do
+      @diff_to_html.lines_are_sequential?({
+        :added => 2,
+        :removed => 2
+      }, {
+        :added => 4,
+        :removed => 6
+      }).should be_false
+    end
+
+    it "should be true if left line numbers are sequential (right are nil)" do
+      @diff_to_html.lines_are_sequential?({
+        :added => 2,
+        :removed => 2
+      }, {
+        :added => 3,
+        :removed => nil
+      }).should be_true
+    end
+
+    it "should be true if right line numbers are sequential (left are nil)" do
+      @diff_to_html.lines_are_sequential?({
+        :added => nil,
+        :removed => 2
+      }, {
+        :added => 7,
+        :removed => 3
+      }).should be_true
+    end
+
+    it "should be false unless line numbers are sequential (nils)" do
+      @diff_to_html.lines_are_sequential?({
+        :added => nil,
+        :removed => nil
+      }, {
+        :added => 4,
+        :removed => 6
+      }).should be_false
+    end
+  end
+
+  describe :unique_commits_per_branch? do
+    it "should be false unless specified in config" do
+      diff = DiffToHtml.new(nil, {})
+      diff.should_not be_unique_commits_per_branch
+    end
+
+    it "should be false if specified as false in config" do
+      diff = DiffToHtml.new(nil, { 'unique_commits_per_branch' => false })
+      diff.should_not be_unique_commits_per_branch
+    end
+
+    it "should be true if specified as true in config" do
+      diff = DiffToHtml.new(nil, { 'unique_commits_per_branch' => true })
+      diff.should be_unique_commits_per_branch
+    end
+  end
+
+  describe :get_previous_commits do
+    it "should read and parse previous file if it exists" do
+      fn = DiffToHtml::HANDLED_COMMITS_FILE
+      diff = DiffToHtml.new
+      mock(File).exists?(fn) { true }
+      mock(IO).read(fn) { "a\nb" }
+      diff.get_previous_commits(fn).should == %w[a b]
+    end
+  end
+
+  it "multiple commits" do
+    mock(Git).log(REVISIONS.first, REVISIONS.last) { IO.read(FIXTURES_PATH + 'git_log') }
+    REVISIONS.each do |rev|
+      mock(Git).show(rev) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
+    end
+
+    diff = DiffToHtml.new
+    mock(diff).check_handled_commits(anything, 'master') { |commits, branch| commits }
+    diff.diff_between_revisions REVISIONS.first, REVISIONS.last, 'testproject', 'master'
+
+    diff.result.should have(5).commits # one result for each of the commits
+
+    diff.result.each do |html|
+      html.should_not be_include('@@') # diff correctly processed
+    end
+
+    # first commit
+    hp = Hpricot 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|
+      if td.inner_html == "require 'iconv'"
+        # first added line in changeset a4629e707d80a5769f7a71ca6ed9471015e14dc9
+        td.parent.search('td')[0].inner_text.should == '' # left
+        td.parent.search('td')[1].inner_text.should == '2' # right
+        td.parent.search('td')[2].inner_html.should == "require 'iconv'" # change
+      end
+    end
+
+    # second commit
+    hp = Hpricot 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/"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'
+    (hp/"h2")[3].inner_text.should == 'Deleted file railties/doc/guides/source/icons/README'
+    (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/"table").should have(3).tables # 3 files updated
+    (hp/"table/tr/").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
+      end
+    end
+  end
+
+  it "should get good diff when new branch created" do
+    first_rev, last_rev = %w[ 0000000000000000000000000000000000000000 9b15cebcc5434e27c00a4a2acea43509f9faea21 ]
+    mock(Git).branch_commits('rvm') { %w[ ff037a73fc1094455e7bbf506171a3f3cf873ae6 ] }
+    %w[ ff037a73fc1094455e7bbf506171a3f3cf873ae6 ].each do |rev|
+      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 }
+    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/"table").should have(1).table
+    (hp/"tr.r").should have(1).row
+  end
+end
+

data/spec/lib/emailer_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+require 'erb'
+require 'emailer'
+
+describe Emailer do
+
+  describe :new do
+    it "should assign config if given" do
+      Emailer.new({:a => :b}).config[:a].should == :b
+    end
+
+    it "should use empty hash unless config given" do
+      cfg = Emailer.new(false).config
+      cfg.should be_kind_of(Hash)
+      cfg.should be_empty
+    end
+
+    it "should not generate message from template" do
+      any_instance_of(Emailer) do |emailer|
+        dont_allow(emailer).generate_message
+      end
+      Emailer.new({})
+    end
+
+    it "should assign parameters from options" do
+      options = {}
+      Emailer::PARAMETERS.each do |name|
+        options[name.to_sym] = Faker::Lorem.sentence
+      end
+      emailer = Emailer.new({}, options)
+      options.each_pair do |key, value|
+        emailer.instance_variable_get("@#{key}").should == value
+      end
+    end
+  end
+
+  describe :stylesheet_string do
+    it "should return default stylesheet if custom is not provided" do
+      emailer = Emailer.new({})
+      mock(IO).read(Emailer::DEFAULT_STYLESHEET_PATH) { 'ok' }
+      emailer.stylesheet_string.should == 'ok'
+    end
+
+    it "should return custom stylesheet if custom is provided" do
+      emailer = Emailer.new({'stylesheet' => '/path/to/custom/stylesheet'})
+      mock(IO).read('/path/to/custom/stylesheet') { 'ok' }
+      dont_allow(IO).read(Emailer::DEFAULT_STYLESHEET_PATH)
+      emailer.stylesheet_string.should == 'ok'
+    end
+  end
+
+  describe :generate_message do
+    it "should generate html" do
+      options = {}
+      Emailer::PARAMETERS.each do |name|
+        options[name.to_sym] = Faker::Lorem.sentence
+      end
+      emailer = Emailer.new({}, options)
+      emailer.generate_message
+      emailer.instance_variable_get(:@html).should match(/html/)
+    end
+  end
+
+  describe :template do
+    before(:each) do
+      Emailer.reset_template
+      mock(IO).read(Emailer::TEMPLATE) { 'erb' }
+    end
+
+    it "should respond to result" do
+      Emailer.template.should respond_to(:result)
+    end
+
+    it "should return Erubis template if Erubis installed" do
+      mock(Emailer).require('erubis')
+      dont_allow(Emailer).require('erb')
+      unless defined?(Erubis)
+        module Erubis
+          class Eruby
+            def initialize(erb)
+            end
+          end
+        end
+      end
+      mock.proxy(Erubis::Eruby).new('erb')
+      Emailer.template.should be_kind_of(Erubis::Eruby)
+    end
+
+    it "should return ERB template unless Erubis installed" do
+      mock(Emailer).require('erubis') { raise LoadError.new('erubis') }
+      mock(Emailer).require('erb')
+      mock.proxy(ERB).new('erb')
+      Emailer.template.should be_kind_of(ERB)
+    end
+  end
+end
+
+__END__
+
+ vim: tabstop=2 expandtab shiftwidth=2
+