git-commit-notifier 0.11.6 → 0.11.9

data/.travis.yml

@@ -1,3 +1,8 @@
+language: ruby
+before_install:
+  - gem install bundler
+install:
+  - bundle install
 notifications:
   recipients:
     - bodo@wannawork.de
@@ -7,4 +12,4 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
-
+  - 2.0.0

data/README.md

@@ -1,6 +1,6 @@
 # Git Commit Notifier
 
-[![Build Status](http://travis-ci.org/bitboxer/git-commit-notifier.png)](http://travis-ci.org/bitboxer/git-commit-notifier)
+[![Build Status](https://travis-ci.org/git-commit-notifier/git-commit-notifier.png)](https://travis-ci.org/git-commit-notifier/git-commit-notifier)
 
 __by Bodo Tasche (bodo 'at' wannawork 'dot' de), Akzhan Abdulin (akzhan 'dot' abdulin 'at' gmail 'dot' com), Csoma Zoltan  (info 'at' railsprogrammer 'dot' net)__
 
@@ -52,7 +52,7 @@ git-commit-notifier path_to_config.yml
 
 (Don't forget to make that file executable.)
 
-An example for the config file can be found in [config/git-notifier-config.example.yml](http://github.com/bitboxer/git-commit-notifier/blob/master/config/git-notifier-config.example.yml).
+An example for the config file can be found in [config/git-notifier-config.example.yml](http://github.com/git-commit-notifier/git-commit-notifier/blob/master/config/git-notifier-config.example.yml).
 
 If you want to send mails on each commit instead on each push, you should add a file called "post-commit" with this content:
 
@@ -74,7 +74,54 @@ Git-commit-notifier supports easy integration with Redmine, Bugzilla and MediaWi
 Git-commit-notifier can send a webhook just after sending a mail, This webook will be sent in a POST request to a server specified in the configuration (webhook / url), under JSON format following the same syntax as Github webhooks.
 
 * [Cogbot](https://github.com/mose/cogbot) is the irc bot for which that feature was originaly designed for. Only a subset of the Github json file was required for that one so maybe it won't work on all Github webhook recievers.
-* [Github webhooks](https://help.github.com/articles/post-receive-hooks) describes the json format expected and some hints on how to design a webhook reciever.
+* [Github webhooks](https://help.github.com/articles/post-receive-hooks) describes the json format expected and some hints on how to design a webhook reciever.  Be sure to extract the 'ref' from the json.  An example Sinatra server to use git-commit-notifier might look like:
+
+```ruby
+require 'rubygems'
+require 'json'
+require 'sinatra'
+
+post '/' do
+  if params[:payload]
+    push = JSON.parse(params[:payload])
+
+    repo = push['repository']['name']
+    before_id = push['before']
+    after_id = push['after']
+    ref = push['ref']
+
+    system("/usr/local/bin/change-notify.sh #{repo} #{before_id} #{after_id} #{ref}")
+  end
+end
+```
+
+change-notify.sh might look like:
+
+```sh
+#!/bin/sh
+
+set -e
+
+EXPECTED_ARGS=4
+E_BADARGS=65
+
+if [ $# -ne $EXPECTED_ARGS ]
+then
+    echo "Usage: `basename $0` {repo} {before commit ID} {after commit ID} {ref}"
+    exit $E_BADARGS
+fi
+
+REPO=$1
+BEFORE=$2
+AFTER=$3
+REF=$4
+CONFIG=myconfig.yml
+
+# Assume repository exists in directory and user has pull access
+cd /repository/$REPO
+git pull
+echo $BEFORE $AFTER $REF | /usr/local/bin/git-commit-notifier $CONFIG
+```
 
 ## Integration of links to other websites
 
@@ -104,9 +151,28 @@ you should receive new message about commit when it's merged in other branch.
 Yet another option, skip\_commits\_older\_than (in days), should be used to not inform about
 old commits in processes of forking, branching etc.
 
+## Note on development
+
+It's easy to fork and clone our repository.
+
+Next step is installation of required dependencies:
+
+```bash
+cd $GCN_REPO
+bundle install
+rake # Run specs
+```
+
+Now you can create test configuration file (example provided in `config` directory) and test your code over any test repository in this manner:
+
+```bash
+cd $TEST_REPO
+echo "HEAD^1 HEAD refs/heads/master" | $GCN_REPO/local-run.rb $PATH_TO_YAML_CONFIG
+```
+
 ## Note on Patches/Pull Requests
 
-* Fork [the project](https://github.com/bitboxer/git-commit-notifier).
+* Fork [the project](https://github.com/git-commit-notifier/git-commit-notifier).
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.

data/VERSION

@@ -1 +1 @@
-0.11.6
+0.11.9

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

@@ -180,7 +180,10 @@ unique_commits_per_branch: false
 show_master_branch_name: false
 
 # ignore whitespace?
-ignore_whitespace: true
+#  all: ignore all whitespace (same as true)
+#  change: ignore changes in amount of whitespace
+#  none: do not ignore any whitespace (same as false)
+ignore_whitespace: all
 
 # adding parameters to send webhooks
 # webooks:

data/git-commit-notifier.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<rspec-core>, [">= 0"])
   s.add_development_dependency(%q<rspec-expectations>, [">= 0"])
   s.add_development_dependency(%q<rr>, ["~> 1.0"])
-  s.add_development_dependency(%q<faker>, ["~> 1.0"])
+  s.add_development_dependency(%q<faker>, ["~> 1.1.2"])
   s.add_development_dependency(%q<yard>, ["~> 0.8.1"])
   s.add_development_dependency(%q<redcarpet>, ["~> 2.1"])
 end

data/lib/git_commit_notifier/diff_to_html.rb

@@ -11,6 +11,8 @@ module GitCommitNotifier
   class DiffToHtml
     include EscapeHelper
 
+
+
     # Integration map for commit message keywords to third-party links.
     INTEGRATION_MAP = {
       :mediawiki => { :search_for => /\[\[([^\[\]]+)\]\]/, :replace_with => '#{url}/\1' },
@@ -49,6 +51,10 @@ module GitCommitNotifier
       @file_removed = false
       @file_changes = []
       @binary = false
+      unless String.method_defined?(:encode!)
+        require 'iconv'
+        @ic = Iconv.new('UTF-8', 'UTF-8//IGNORE')
+      end
     end
 
     def range_info(range)
@@ -90,9 +96,11 @@ module GitCommitNotifier
     end
 
     # Gets ignore_whitespace setting from {#config}.
-    # @return [Boolean] true if whitespaces should be ignored in diff; otherwise false.
-    def ignore_whitespaces?
-      config['ignore_whitespace'].nil? || config['ignore_whitespace']
+    # @return [String] How whitespaces should be treated in diffs (none, all, change)
+    def ignore_whitespace
+      return 'all' if config['ignore_whitespace'].nil?
+      return 'none' if !config['ignore_whitespace']
+      (['all', 'change', 'none'].include?(config['ignore_whitespace']) ? config['ignore_whitespace'] : 'all')
     end
 
     # Adds separator between diff blocks to @diff_result.
@@ -184,17 +192,24 @@ module GitCommitNotifier
 
       file_name = @current_file_name
 
+      text = "#{op} #{binary}file #{file_name}"
+
       # TODO: these filenames, etc, should likely be properly html escaped
+      file_link = file_name
       if config['link_files']
-        file_name = if config["link_files"] == "gitweb" && config["gitweb"]
+        file_link = if config["link_files"] == "gitweb" && config["gitweb"]
           "<a href='#{config['gitweb']['path']}?p=#{config['gitweb']['project'] || "#{Git.repo_name}.git"};f=#{file_name};h=#{@current_sha};hb=#{@current_commit}'>#{file_name}</a>"
         elsif config["link_files"] == "gitorious" && config["gitorious"]
           "<a href='#{config['gitorious']['path']}/#{config['gitorious']['project']}/#{config['gitorious']['repository']}/blobs/#{branch_name}/#{file_name}'>#{file_name}</a>"
+        elsif config["link_files"] == "trac" && config["trac"]
+          "<a href='#{config['trac']['path']}/#{@current_commit}/#{file_name}'>#{file_name}</a>"
         elsif config["link_files"] == "cgit" && config["cgit"]
-          "<a href='#{config['cgit']['path']}/#{config['cgit']['project']}/tree/#{file_name}'>#{file_name}</a>"
+          "<a href='#{config['cgit']['path']}/#{config['cgit']['project']}/tree/#{file_name}?h=#{branch_name}'>#{file_name}</a>"
         elsif config["link_files"] == "gitlabhq" && config["gitlabhq"]
           if config["gitlabhq"]["version"] && config["gitlabhq"]["version"] < 1.2
             "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name.gsub(".", "_")}/tree/#{@current_commit}/#{file_name}'>#{file_name}</a>"
+          elsif config["gitlabhq"]["version"] && config["gitlabhq"]["version"] >= 4.0
+            "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name_with_parent.gsub(".", "_")}/commit/#{@current_commit}'>#{file_name}</a>"
           else
             "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name.gsub(".", "_")}/#{@current_commit}/tree/#{file_name}'>#{file_name}</a>"
           end
@@ -205,13 +220,14 @@ module GitCommitNotifier
         end
       end
 
-      header = "#{op} #{binary}file #{file_name}"
-
       if show_summary?
-        @file_changes << [ file_name, header ]
+        @file_changes << {
+          :file_name => file_name, 
+          :text => text,
+        }
       end
 
-      "<h2 id=\"#{file_name}\">#{header}</h2>\n"
+      "<a name=\"#{file_name}\"></a><h2>#{op} #{binary}file #{file_link}</h2>\n"
     end
 
     # Determines are two lines are sequentially placed in diff (no skipped lines between).
@@ -504,16 +520,25 @@ module GitCommitNotifier
     # @see COMMIT_LINK_MAP
     def markup_commit_for_html(commit)
       mode = (config["link_files"] || "default").to_sym
-      mode = :default  unless config.has_key?(mode)
+      mode = :default  unless config.has_key?(mode.to_s)
       mode = :default  unless COMMIT_LINK_MAP.has_key?(mode)
       COMMIT_LINK_MAP[mode].call(config, commit)
     end
 
     def diff_for_commit(commit)
       @current_commit = commit
-      raw_diff = truncate_long_lines(Git.show(commit, :ignore_whitespaces => ignore_whitespaces?))
+      raw_diff = truncate_long_lines(Git.show(commit, :ignore_whitespace => ignore_whitespace))
       raise "git show output is empty" if raw_diff.empty?
 
+      if raw_diff.respond_to?(:encode!)
+        unless raw_diff.valid_encoding?
+          raw_diff.encode!("UTF-16", "UTF-8", :invalid => :replace, :undef => :replace)
+          raw_diff.encode!("UTF-8", "UTF-16")
+        end
+      else
+        raw_diff = @ic.iconv(raw_diff)
+      end
+
       commit_info = extract_commit_info_from_git_show_output(raw_diff)
       return nil  if old_commit?(commit_info)
       changed_files = ""
@@ -551,12 +576,12 @@ module GitCommitNotifier
       html_diff = diff_for_revision(extract_diff_from_git_show_output(raw_diff))
       message_array = message_array_as_html(changed_files.split("\n"))
 
-      if show_summary? and @file_changes.respond_to?("each")
+      if show_summary?
         title += "<ul>"
 
-        @file_changes.each do |file_name, header|
-          title += "<li><a href=\"\##{file_name}\">#{header}</a></li>"
-          text += "#{header}\n"
+        @file_changes.each do |change|
+          title += "<li><a href=\"\##{change[:file_name]}\">#{change[:text]}</a></li>"
+          text += "#{change[:text]}\n"
         end
 
         title += "</ul>"
@@ -651,10 +676,10 @@ module GitCommitNotifier
         html += "<dt>Message</dt><dd class='#{multi_line_message ? "multi-line" : ""}'>#{message_array_as_html(message_array)}</dd>\n"
         html += "</dl>"
 
-        text = "Tag:</strong> #{tag} (#{change_type == :create ? "added" : "updated"})\n"
+        text = "Tag: #{tag} (#{change_type == :create ? "added" : "updated"})\n"
         text += "Type: annotated\n"
         text += "Commit: #{tag_info[:tagobject]}\n"
-        text += "Tagger: tag_info[:taggername] tag_info[:taggeremail]\n"
+        text += "Tagger: #{tag_info[:taggername]} #{tag_info[:taggeremail]}\n"
         text += "Message: #{tag_info[:contents]}\n"
 
         commit_info[:message] = message

data/lib/git_commit_notifier/emailer.rb

@@ -9,7 +9,7 @@ class GitCommitNotifier::Emailer
   # Default ERB template file path
   TEMPLATE = File.join(File.dirname(__FILE__), *'../../template/email.html.erb'.split('/')).freeze
   # Instance variable names
-  PARAMETERS = %w[project_path recipient from_address from_alias date subject text_message html_message repo_name ref_name old_rev new_rev].freeze
+  PARAMETERS = %w[project_path recipient from_address from_alias reply_to_address date subject text_message html_message repo_name ref_name old_rev new_rev].freeze
 
   # Gets config.
   # @return [Hash] Configuration

data/lib/git_commit_notifier/git.rb

@@ -30,11 +30,12 @@ class GitCommitNotifier::Git
     # @see from_shell
     # @param [String] rev Revision
     # @param [Hash] opts Options
-    # @option opts [Boolean] :ignore_whitespaces Ignore whitespaces or not
+    # @option opts [String] :ignore_whitespace How whitespaces should be treated
     def show(rev, opts = {})
       gitopt = " --date=rfc2822"
       gitopt += " --pretty=fuller"
-      gitopt += " -w" if opts[:ignore_whitespaces]
+      gitopt += " -w" if opts[:ignore_whitespace] == 'all'
+      gitopt += " -b" if opts[:ignore_whitespace] == 'change'
       from_shell("git show #{rev.strip}#{gitopt}")
     end
 
@@ -97,6 +98,10 @@ class GitCommitNotifier::Git
       from_shell("git rev-parse --git-dir").strip
     end
 
+    def toplevel_dir
+      from_shell("git rev-parse --show-toplevel").strip
+    end
+
     def rev_parse(param)
       from_shell("git rev-parse '#{param}'").strip
     end
@@ -167,7 +172,34 @@ class GitCommitNotifier::Git
         ''
       end
       return git_prefix  unless git_prefix.empty?
-      File.expand_path(git_dir).split("/").last.sub(/\.git$/, '')
+      git_path = toplevel_dir
+      # In a bare repository, toplevel directory is empty.  Revert to git_dir instead.
+      if git_path.empty?
+        git_path = git_dir
+      end
+      File.expand_path(git_path).split("/").last.sub(/\.git$/, '')
+    end
+
+	# Gets repository name.
+    # @note Tries to gets human readable repository name through `git config hooks.emailprefix` call.
+    #       If it's not specified then returns directory name with parent directory name (except '.git'
+	#       suffix if exists).
+    # @return [String] Human readable repository name.
+    def repo_name_with_parent
+      git_prefix = begin
+        from_shell("git config hooks.emailprefix").strip
+      rescue ArgumentError
+        ''
+      end
+      return git_prefix  unless git_prefix.empty?
+      git_path = toplevel_dir
+      # In a bare repository, toplevel directory is empty.  Revert to git_dir instead.
+      if git_path.empty?
+        git_path = git_dir
+      end
+      name_with_parent = File.expand_path(git_path).scan(/[a-zA-z0-9]+\/[a-zA-Z0-9]+.git$/).first;
+      return name_with_parent.sub(/\.git$/, '') unless name_with_parent.empty?
+      File.expand_path(git_path).split("/").last.sub(/\.git$/, '')
     end
 
     # Gets mailing list address.

data/spec/lib/git_commit_notifier/commit_hook_spec.rb

@@ -79,7 +79,7 @@ describe GitCommitNotifier::CommitHook do
     mock(GitCommitNotifier::Git).repo_name { 'testproject' }
     mock(GitCommitNotifier::Git).changed_files('7e4f6b4', '4f13525') { [] }
     REVISIONS.each do |rev|
-      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + "git_show_#{rev}") }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespace => 'all') { IO.read(FIXTURES_PATH + "git_show_#{rev}") }
       dont_allow(GitCommitNotifier::Git).describe(rev) { IO.read(FIXTURES_PATH + "git_describe_#{rev}") }
     end
   end

data/spec/lib/git_commit_notifier/diff_to_html_spec.rb

@@ -106,7 +106,7 @@ describe GitCommitNotifier::DiffToHtml do
     mock(GitCommitNotifier::Git).rev_type(REVISIONS.last) { "commit" }
     mock(GitCommitNotifier::Git).new_commits(anything, anything, anything, anything) { REVISIONS.reverse }
     REVISIONS.each do |rev|
-      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespace => 'all') { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
       dont_allow(GitCommitNotifier::Git).describe(rev) { IO.read(FIXTURES_PATH + 'git_describe_' + rev) }
     end
 
@@ -161,7 +161,7 @@ describe GitCommitNotifier::DiffToHtml do
     mock(GitCommitNotifier::Git).rev_type(last_rev) { "commit" }
     mock(GitCommitNotifier::Git).new_commits(anything, anything, anything, anything) { [ 'ff037a73fc1094455e7bbf506171a3f3cf873ae6' ] }
     %w[ ff037a73fc1094455e7bbf506171a3f3cf873ae6 ].each do |rev|
-      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespace => 'all') { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
       dont_allow(GitCommitNotifier::Git).describe(rev) { IO.read(FIXTURES_PATH + 'git_describe_' + rev) }
     end
     diff = GitCommitNotifier::DiffToHtml.new

data/spec/lib/git_commit_notifier/git_spec.rb

@@ -17,18 +17,18 @@ describe GitCommitNotifier::Git do
     it "should get data from shell: git show without whitespaces" do
       expected = 'some data from git show'
       mock(GitCommitNotifier::Git).from_shell("git show #{SAMPLE_REV} --date=rfc2822 --pretty=fuller -w") { expected }
-      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespaces => true).should == expected
+      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespace => 'all').should == expected
     end
 
     it "should get data from shell: git show with whitespaces" do
       expected = 'some data from git show'
       mock(GitCommitNotifier::Git).from_shell("git show #{SAMPLE_REV} --date=rfc2822 --pretty=fuller") { expected }
-      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespaces => false).should == expected
+      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespace => 'none').should == expected
     end
 
     it "should strip given revision" do
       mock(GitCommitNotifier::Git).from_shell("git show #{SAMPLE_REV} --date=rfc2822 --pretty=fuller -w")
-      GitCommitNotifier::Git.show("#{SAMPLE_REV}\n", :ignore_whitespaces => true)
+      GitCommitNotifier::Git.show("#{SAMPLE_REV}\n", :ignore_whitespace => 'all')
     end
   end
 
@@ -70,15 +70,23 @@ describe GitCommitNotifier::Git do
 
     it "should return folder name if no emailprefix and directory not ended with .git" do
       mock(GitCommitNotifier::Git).from_shell("git config hooks.emailprefix") { " " }
-      mock(GitCommitNotifier::Git).git_dir { "/home/someuser/repositories/myrepo" }
+      stub(GitCommitNotifier::Git).toplevel_dir { "/home/someuser/repositories/myrepo" }
       GitCommitNotifier::Git.repo_name.should == "myrepo"
     end
 
     it "should return folder name without extension if no emailprefix and directory ended with .git" do
       mock(GitCommitNotifier::Git).from_shell("git config hooks.emailprefix") { " " }
-      mock(GitCommitNotifier::Git).git_dir { "/home/someuser/repositories/myrepo.git" }
+      stub(GitCommitNotifier::Git).toplevel_dir { "/home/someuser/repositories/myrepo.git" }
       GitCommitNotifier::Git.repo_name.should == "myrepo"
     end
+
+    it "should return folder name if no emailprefix and toplevel dir and directory not ended with .git" do
+      mock(GitCommitNotifier::Git).from_shell("git config hooks.emailprefix") { " " }
+      stub(GitCommitNotifier::Git).toplevel_dir { "" }
+      stub(GitCommitNotifier::Git).git_dir { "/home/someuser/repositories/myrepo.git" }
+      GitCommitNotifier::Git.repo_name.should == "myrepo"
+    end
+
   end
 
   describe :log do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-commit-notifier
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.11.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -219,7 +219,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -227,7 +227,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -338,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 856165003090577153
+      hash: 1338348343432938380
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: