git-commit-notifier 0.8.0 → 0.8.1

data/LICENSE

@@ -1,4 +1,4 @@
- Copyright (c) 2008, 2010 Bodo Tasche, Csoma Zoltan, Primalgrasp
+ Copyright (c) 2008, 2010 Bodo Tasche, Akzhan Abdulin, Csoma Zoltan, Primalgrasp
  
  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation

data/README.textile

@@ -1,6 +1,6 @@
 h1. Git Commit Notifier
 
-__by Bodo Tasche (bodo 'at' wannawork 'dot' de), Csoma Zoltan (Primalgrasp) (zoltan 'at' primalgrasp 'dot' com)__
+__by Bodo Tasche (bodo 'at' wannawork 'dot' de), Akzhan Abdulin (akzhan 'dot' abdulin 'at' gmail 'dot' com), Csoma Zoltan (Primalgrasp) (zoltan 'at' primalgrasp 'dot' com)__
 
 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 
@@ -44,6 +44,13 @@ 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>.
 
+If you want to send mails on each commit instead on each pull, you should add a file called "post-commit" with this content:
+
+<pre>
+#!/bin/sh
+echo "HEAD^1 HEAD refs/heads/master" | git-commit-notifier path_to_config.yml
+</pre>
+
 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).
@@ -67,6 +74,17 @@ Key and value are enclosed into single quotes. \b means that "follow" must not b
 
 More examples can be found in the config file.
 
+h2. Logic of commits handling
+
+Commit notifier use special files named *previously.txt to track already
+handled commits to not send repeated messages about commits.
+
+By default all commits tracked through overall repository so after merge action
+You should not receive messages about commits those already posted in other branches.
+
+This behaviour can be changed using unique_commits_per_branch option. When it's true,
+you should receive new message about commit when it's merged in other branch.
+
 h2. Note on Patches/Pull Requests
  
 * Fork the project.
@@ -81,10 +99,7 @@ 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>
+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. The git repo owner needs the right to write into that file. 
 
 h2. License
 

data/Rakefile

@@ -1,55 +1,75 @@
 require 'rubygems'
 require 'rake'
 
+APP_ROOT = File.dirname(__FILE__).freeze
+
 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.email = "bodo@bitboxer.de"
+    gem.homepage = "http://github.com/bitboxer/git-commit-notifier"
     gem.authors = ["Bodo Tasche"]
     gem.add_dependency('diff-lcs')
     gem.add_dependency('mocha')
     gem.add_dependency('hpricot')
     gem.add_dependency('tamtam')
+    gem.add_development_dependency('rspec-core')
+    gem.add_development_dependency('rspec-expectations')
+    gem.add_development_dependency('rr')
+    gem.add_development_dependency('faker')
+    gem.add_development_dependency('rcov')
+    gem.add_development_dependency('metric_fu')
   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
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = ["-c", "-f progress"]
   end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.rcov = true
+    t.ruby_opts = '-w'
+    t.rspec_opts = ["-c", "-f progress"]
+    t.rcov_opts = %q[-Ilib --exclude "spec/*,gems/*"]
   end
+rescue LoadError
+  $stderr.puts "RSpec not available. Install it with: gem install rspec-core rspec-expectations"
 end
 
-task :test => :check_dependencies
+task :default => :spec
 
-task :default => :test
+begin
+  require 'metric_fu'
+rescue LoadError
+  $stderr.puts "metric_fu not available. Install it with: gem install metric_fu"
+end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exists?('VERSION') ? IO.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "git-commit-notifier #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+begin
+  gem 'code-cleaner'
+  desc 'Clean code for whitespaces and tabs'
+  task :'code:clean' do
+    system('code-cleaner lib spec Rakefile bin/git-commit-notifier')
+  end
+rescue LoadError
+  $stderr.puts "code-cleaner not available. Install it with: gem install code-cleaner"
+end
+

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/bin/git-commit-notifier

@@ -1,4 +1,11 @@
 #!/usr/bin/env ruby
+
+if RUBY_VERSION < '1.9'
+  # This is for Unicode support in Ruby 1.8
+  $KCODE = 'u';
+  require 'jcode'
+end
+
 # parameters: revision1, revision 2, branch
 THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 $:.unshift File.join(File.dirname(THIS_FILE), "../lib")
@@ -17,4 +24,4 @@ when 3
   CommitHook.run ARGV[0], ARGV[1], ARGV[2], ""
 else
   CommitHook.run ARGV[0], ARGV[1], ARGV[2], ARGV[3]
-end
+end

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

@@ -1,18 +1,22 @@
-# The recipient for the commit:
-mailinglist: developers@example.com 
-
 # set to true if you want to ignore empty merge messages
 ignore_merge: false 
 
 # Optional parameter for the subject-line of the mail 
 # emailprefix: GIT
 
-# Decorate files with link to a webview. Possible values: none, gitweb or gitorious
-link_files: none 
-
 # Limit lines per diff
 # lines_per_diff: 300
 
+# The recipient for the commit:
+mailinglist: developers@example.com 
+
+# The from addres. If not defined it will use 
+# the address that is configured in git
+# from: sender@example.com
+
+# stylesheet file (embedded template/styles.css by default)
+# stylesheet: /absolute/path/to/readable/stylesheet.css
+
 # select the delivery method: smtp or sendmail 
 delivery_method: sendmail 
 
@@ -34,15 +38,8 @@ 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
+# Decorate files and commit ids with link to a webview. Possible values: none, gitweb, gitorious, cgit or trac
+link_files: none 
 
 # If link_files is set to "gitweb", you need to configure the path to your gitweb
 # instance and the project name.
@@ -57,3 +54,32 @@ gitorious:
   project: backend
   repository: sql-scripts
 
+# if link_files is set to "cgit", you need to configure the path to your cgit
+cgit:
+  path: http://example.com/path_to_cgit
+  project: backend
+
+# If link_files is set to "trac", you need to configure the path to your trac
+# instance
+trac:
+  path: http://example.com/changeset
+
+# 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
+#  fogbugz: http://yourondemand.fogbugz.com/? # will rework BugzId: 123 to FogBugz cases
+
+# Track unique commits per branch?
+unique_commits_per_branch: false
+
+# This is developer debugging options. Do not uncomment it if You aren't Jedi
+# debug:
+#   enable: true
+#   log_directory: /path/to/log/directory
+

data/git-commit-notifier.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git-commit-notifier}
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bodo Tasche"]
-  s.date = %q{2010-08-06}
+  s.date = %q{2010-11-03}
   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.email = %q{bodo@bitboxer.de}
   s.executables = ["git-commit-notifier"]
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,35 +32,43 @@ Gem::Specification.new do |s|
      "lib/diff_to_html.rb",
      "lib/emailer.rb",
      "lib/git.rb",
+     "lib/logger.rb",
      "lib/result_processor.rb",
+     "spec/fixtures/existing_file_one_line.txt",
+     "spec/fixtures/git-notifier-group-email-by-push.yml",
+     "spec/fixtures/git-notifier-ignore-merge.yml",
+     "spec/fixtures/git-notifier-with-merge.yml",
+     "spec/fixtures/git_log",
+     "spec/fixtures/git_show_055850e7d925110322b8db4e17c3b840d76e144c",
+     "spec/fixtures/git_show_51b986619d88f7ba98be7d271188785cbbb541a0",
+     "spec/fixtures/git_show_a4629e707d80a5769f7a71ca6ed9471015e14dc9",
+     "spec/fixtures/git_show_dce6ade4cdc2833b53bd600ef10f9bce83c7102d",
+     "spec/fixtures/git_show_e28ad77bba0574241e6eb64dfd0c1291b221effe",
+     "spec/fixtures/git_show_ff037a73fc1094455e7bbf506171a3f3cf873ae6",
+     "spec/fixtures/new_file_one_line.txt",
+     "spec/lib/commit_hook_spec.rb",
+     "spec/lib/diff_to_html_spec.rb",
+     "spec/lib/emailer_spec.rb",
+     "spec/lib/git_spec.rb",
+     "spec/lib/logger_spec.rb",
+     "spec/lib/result_processor_spec.rb",
+     "spec/spec_helper.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",
-     "test/fixtures/git_show_055850e7d925110322b8db4e17c3b840d76e144c",
-     "test/fixtures/git_show_51b986619d88f7ba98be7d271188785cbbb541a0",
-     "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",
-     "test/unit/test_result_processor.rb"
+     "template/styles.css"
   ]
-  s.homepage = %q{http://github.com/bodo/git-commit-notifier}
+  s.homepage = %q{http://github.com/bitboxer/git-commit-notifier}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   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"
+    "spec/lib/commit_hook_spec.rb",
+     "spec/lib/diff_to_html_spec.rb",
+     "spec/lib/emailer_spec.rb",
+     "spec/lib/git_spec.rb",
+     "spec/lib/logger_spec.rb",
+     "spec/lib/result_processor_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -72,17 +80,35 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<mocha>, [">= 0"])
       s.add_runtime_dependency(%q<hpricot>, [">= 0"])
       s.add_runtime_dependency(%q<tamtam>, [">= 0"])
+      s.add_development_dependency(%q<rspec-core>, [">= 0"])
+      s.add_development_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<faker>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<metric_fu>, [">= 0"])
     else
       s.add_dependency(%q<diff-lcs>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<hpricot>, [">= 0"])
       s.add_dependency(%q<tamtam>, [">= 0"])
+      s.add_dependency(%q<rspec-core>, [">= 0"])
+      s.add_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<faker>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<metric_fu>, [">= 0"])
     end
   else
     s.add_dependency(%q<diff-lcs>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<hpricot>, [">= 0"])
     s.add_dependency(%q<tamtam>, [">= 0"])
+    s.add_dependency(%q<rspec-core>, [">= 0"])
+    s.add_dependency(%q<rspec-expectations>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<faker>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<metric_fu>, [">= 0"])
   end
 end
 

data/lib/commit_hook.rb

@@ -1,99 +1,129 @@
 require 'rubygems'
+require 'yaml'
 require 'cgi'
 require 'net/smtp'
-require 'sha1'
+require 'digest/sha1'
 
+require 'logger'
 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
+  class << self
+    attr_reader :config
+
+    def show_error(message)
+      $stderr.puts "************** GIT NOTIFIER PROBLEM *******************"
+      $stderr.puts "\n"
+      $stderr.puts message
+      $stderr.puts "\n"
+      $stderr.puts "************** GIT NOTIFIER PROBLEM *******************"
+    end
 
-  def self.run(config, rev1, rev2, ref_name)
-    @config = {}
-    @config = YAML::load_file(config) if File.exist?(config)
-
-    project_path = Dir.getwd
-    recipient = @config["mailinglist"] || 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
+    def info(message)
+      $stdout.puts message
+      $stdout.flush
     end
-    
-    puts "Sending mail..."
-    STDOUT.flush
-    
+
+    def logger
+      @logger ||= Logger.new(config)
+    end
+
+    def run(config_name, rev1, rev2, ref_name)
+      @config = File.exists?(config_name) ? YAML::load_file(config_name) : {}
+
+      project_path = Dir.getwd
+      recipient = config["mailinglist"] || 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
+
+      logger.debug('----')
+      logger.debug("pwd: #{Dir.pwd}")
+      logger.debug("ref_name: #{ref_name}")
+      logger.debug("rev1: #{rev1}")
+      logger.debug("rev2: #{rev2}")
+
+
+      info("Sending mail...")
+
     prefix = @config["emailprefix"] || Git.repo_name
     branch_name = (ref_name =~ /master$/i) ? "" : "/#{ref_name.split("/").last}"
 
-    diff2html = DiffToHtml.new(Dir.pwd, @config)
-    diff2html.diff_between_revisions rev1, rev2, prefix, ref_name
-    
-    diffresult = diff2html.result
+      logger.debug("prefix: #{prefix}")
+      logger.debug("branch: #{branch_name}")
 
-    if (@config["ignore_merge"])
-      diffresult = diffresult.reject {|result|
-        !result[:commit_info][:merge].nil?
-      }
-    end
+      diff2html = DiffToHtml.new(Dir.pwd, config)
+      diff2html.diff_between_revisions(rev1, rev2, prefix, ref_name)
+
+      diffresult = diff2html.result
 
-    if (@config["group_email_by_push"])
-      text, html = [], []
-      diffresult.each_with_index do |result, i|
-        text << result[:text_content]
-        html << result[:html_content]
+      if config["ignore_merge"]
+        diffresult = diffresult.reject do |result|
+          !result[:commit_info][:merge].nil?
+        end
       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
+
+      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
+        return if result.nil? || !result[:commit_info]
+
+        emailer = Emailer.new(config,
+          :project_path => project_path,
+          :recipient => recipient,
+          :from_address => config["from"] || result[:commit_info][:email],
+          :from_alias => result[:commit_info][:author],
+          :subject => "[#{prefix}#{branch_name}] #{diffresult.size > 1 ? "#{diffresult.size} commits: " : ''}#{result[:commit_info][:message]}",
+          :text_message => text.join("------------------------------------------\n\n"),
+          :html_message => html.join("<hr /><br />"),
+          :old_rev => rev1,
+          :new_rev => rev2,
+          :ref_name => ref_name
         )
         emailer.send
+      else
+        diffresult.reverse.each_with_index do |result, i|
+          next unless result[:commit_info]
+          nr = number(diffresult.size, i)
+
+          emailer = Emailer.new(config,
+            :project_path => project_path,
+            :recipient => recipient,
+            :from_address => config["from"] || result[:commit_info][:email],
+            :from_alias => result[:commit_info][:author],
+            :subject => "[#{prefix}#{branch_name}]#{nr} #{result[:commit_info][:message]}",
+            :text_message => result[:text_content],
+            :html_message => result[:html_content],
+            :old_rev => rev1,
+            :new_rev => rev2,
+            :ref_name => ref_name
+          )
+          emailer.send
+        end
       end
     end
-  end
 
-  def self.number(total_entries, i)
-    return '' if total_entries <= 1
-    digits = total_entries < 10 ? 1 : 3
-    '[' + sprintf("%0#{digits}d", i) + ']'
+    def number(total_entries, i)
+      return '' if total_entries <= 1
+      digits = total_entries < 10 ? 1 : 3
+      '[' + sprintf("%0#{digits}d", i + 1) + ']'
+    end
   end
-
 end
+
+__END__
+
+ vim: tabstop=2:expandtab:shiftwidth=2
+