git-commit-notifier 0.10.5 → 0.11.0

data/.yardopts

@@ -2,4 +2,6 @@
 --markup-provider redcarpet
 --charset utf-8
 --readme README.md
-
+-
+README.md
+LICENSE

data/README.md

@@ -102,7 +102,7 @@ old commits in processes of forking, branching etc.
 
 ## Note on Patches/Pull Requests
 
-* Fork the project.
+* Fork [the project](https://github.com/bitboxer/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.
@@ -126,5 +126,5 @@ Thanks for [putpat.tv](http://www.putpat.tv), [Primalgrasp](http://www.primalgra
 
 ## License
 
-MIT License, see the file LICENSE.
+MIT License, see the {file:LICENSE}.
 

data/VERSION

@@ -1 +1 @@
-0.10.5
+0.11.0

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

@@ -4,11 +4,40 @@ ignore_merge: false
 # Optional parameter for the subject-line of the mail 
 # emailprefix: GIT
 
-# Limit lines per diff
-# lines_per_diff: 300
+# Set limit on maximum number of lines per file diff
+lines_per_diff: 300
 
 # Show file list only when too many files
-# too_many_files: 1000
+too_many_files: 50
+
+# Whether to expand css inline. May be compatible with more mail readers
+# but consumes much more space and more cpu. Defaults to true
+# expand_css: true
+
+# Determine whether to add plaintext alternative section to generated email.
+# This allows text-only readers an option, but greatly increases the size
+# of generated emails. Defaults to true
+# add_plaintext: true
+
+# Subject: the subject may be set by specifying a template.
+#
+# Substitution into the template is available for the following
+# words, via the form ${word}
+#
+#     prefix                - The emailprefix set, defaulting to repo_name
+#     repo_name             - Name of the git repo
+#     branch_name           - Name of the git branch (master is "" unless show_master_branch_name)
+#     commit_id             - The git commit id (hash)
+#     message               - The commit message
+#     commit_number         - The commit number within the push; 1-based
+#     commit_count          - The number of commits within the push
+#     commit_count_phrase   - The number of commits, as "1 commit", "2 commits", etc.
+#
+# The default subject template varies a little depending on whether 
+# or not group_email_by_push is set.
+#
+#subject: "[${prefix}${branch_name}] ${commit_count_phrase}: ${message}"
+#subject: "[${prefix}${branch_name}][${commit_number}] ${message}"
 
 # defines what branches to email for (defaults to all)
 # include_branches: ['master', 'some_other_branch']
@@ -68,7 +97,8 @@ nntp_settings:
   address: your.nntp.host.here
   port: 119
 
-# Decorate files and commit ids with link to a webview. Possible values: none, gitweb, gitorious, cgit or trac
+# Decorate files and commit ids with link to a webview. Possible values: none, gitweb,
+# gitorious, cgit, trac, gitlabhq, or redmine
 link_files: none 
 
 # If link_files is set to "gitweb", you need to configure the path to your gitweb
@@ -94,6 +124,21 @@ cgit:
 trac:
   path: http://example.com/changeset
 
+# If link_files is set to "gitlabhq", you need to configure the path to your gitlabhq
+# instance
+gitlabhq:
+  path: http://gitlabhq.example.com
+  version: 1.2
+
+# If link_files is set to "redmine", you need to configure the path to your redmine
+# instance
+redmine:
+  path: http://redmine.example.com
+# project: project-name
+# keywords: [refs, fixes]
+# project defaults to git repository name, keywords defaults to refs, fixes (for use with message_integration)
+
+
 # commit message URL map
 message_map:
 #  '\brefs\s*\#(\d+)': 'http://example.com/redmine/issues/show/\1'

data/git-commit-notifier.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables      = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
 
-  s.homepage = %q{http://github.com/bitboxer/git-commit-notifier}
+  s.homepage = %q{http://bitboxer.github.com/git-commit-notifier/}
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Sends git commit messages with diffs}

data/lib/git_commit_notifier/commit_hook.rb

@@ -47,11 +47,9 @@ module GitCommitNotifier
         project_path = Dir.getwd
         recipient = config["mailinglist"] || Git.mailing_list_address
 
+        # If no recipients specified, bail out gracefully. This is not an error, and might be intentional
         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"
-          )
+          info("bypassing commit notification; no recipients specified (consider setting git config hooks.mailinglist)")
           return
         end
 
@@ -62,7 +60,9 @@ module GitCommitNotifier
         logger.debug("rev2: #{rev2}")
         logger.debug("included branches: #{include_branches.join(', ')}") unless include_branches.nil?
 
-        prefix = config["emailprefix"] || Git.repo_name
+        repo_name = Git.repo_name
+        prefix = config["emailprefix"] || repo_name
+        
         branch_name = if ref_name =~ /^refs\/heads\/(.+)$/
           $1
         else
@@ -76,10 +76,30 @@ module GitCommitNotifier
           info("Supressing mail for branch #{branch_name}...")
           return
         end
-
+        
         branch_name = "/#{branch_name}"
         branch_name = "" if !config["show_master_branch_name"] && branch_name == '/master'
-
+        
+        # Replacements for subject template
+        #     prefix
+        #     repo_name
+        #     branch_name
+        #     commit_id (hash)
+        #     short_message
+        #     commit_number
+        #     commit_count
+        #     commit_count_phrase (1 commit, 2 commits, etc)
+        subject_words = {
+          :prefix => prefix,
+          :repo_name => repo_name,
+          :branch_name => branch_name,
+          :commit_id => nil,
+          :message => nil,
+          :commit_number => nil,
+          :commit_count => nil,
+          :commit_count_phrase => nil
+        }
+        
         info("Sending mail...")
 
         diff2html = DiffToHtml.new(Dir.pwd, config)
@@ -102,39 +122,63 @@ module GitCommitNotifier
             text << result[:text_content]
             html << result[:html_content]
           end
+          
+          # Form the subject from template
+          revised_subject_words = subject_words.merge({
+            :commit_id => result[:commit_info][:commit],
+            :message => result[:commit_info][:message],
+            :commit_number => 1,
+            :commit_count => diffresult.size,
+            :commit_count_phrase => diffresult.size == 1 ? "#{diffresult.size} commit" : "#{diffresult.size} commits"
+          })
+          subject_template = config['subject'] || "[${prefix}${branch_name}] ${commit_count_phrase}: ${message}"
+          subject = subject_template.gsub(/\$\{(\w+)\}/) { |m| revised_subject_words[$1.intern] }
 
           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]}",
+            :subject => subject,
             :text_message => text.join("------------------------------------------\n\n"),
             :html_message => html.join("<hr /><br />"),
             :old_rev => rev1,
             :new_rev => rev2,
-            :ref_name => ref_name
+            :ref_name => ref_name,
+            :repo_name => repo_name
           )
           emailer.send
         else
-          i = 0
+          commit_number = 1
           diff2html.diff_between_revisions(rev1, rev2, prefix, ref_name) do |result|
-            next  if config["ignore_merge"] && merge_commit?(result)
-            nr = number(i)
+            next if config["ignore_merge"] && merge_commit?(result)
+            
+            # Form the subject from template
+            revised_subject_words = subject_words.merge({
+              :commit_id => result[:commit_info][:commit],
+              :message => result[:commit_info][:message],
+              :commit_number => commit_number,
+              :commit_count => 1,
+              :commit_count_phrase => "1 commit"
+            })
+            subject_template = config['subject'] || "[${prefix}${branch_name}][${commit_number}] ${message}"
+            subject = subject_template.gsub(/\$\{(\w+)\}/) { |m| revised_subject_words[$1.intern] }
+            
             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]}",
+              :subject => subject,
               :text_message => result[:text_content],
               :html_message => result[:html_content],
               :old_rev => rev1,
               :new_rev => rev2,
-              :ref_name => ref_name
+              :ref_name => ref_name,
+              :repo_name => repo_name
             )
             emailer.send
-            i += 1
+            commit_number += 1
           end
         end
       end

data/lib/git_commit_notifier/diff_to_html.rb

@@ -10,20 +10,27 @@ module GitCommitNotifier
 
     INTEGRATION_MAP = {
       :mediawiki => { :search_for => /\[\[([^\[\]]+)\]\]/, :replace_with => '#{url}/\1' },
-      :redmine => { :search_for => /\b(?:refs|fixes)([\s&,]+\#\d+)+/i, :replace_with => lambda do |m, url|
-        # we can provide Proc that gets matched string and configuration url.
-        # result should be in form of:
-        # { :phrase => 'phrase started with', :links => [ { :title => 'title of url', :url => 'target url' }, ... ] }
-        match = m.match(/^(refs|fixes)(.*)$/i)
-        return m unless match
-        r = { :phrase => match[1] }
-        captures = match[2].split(/[\s\&\,]+/).map { |m| (m =~ /(\d+)/) ? $1 : m }.reject { |c| c.empty? }
-        r[:links] = captures.map { |mn| { :title => "##{mn}", :url => "#{url}/issues/show/#{mn}" } }
-        r
-      end },
+      :redmine => {
+        :search_for => lambda do |config|
+          keywords = (config['redmine'] && config['redmine']['keywords']) || ["refs", "fixes"]
+          /\b(?:#{keywords.join('\b|')})([\s&,]+\#\d+)+/i
+        end,
+        :replace_with => lambda do |m, url, config|
+          # we can provide Proc that gets matched string and configuration url.
+          # result should be in form of:
+          # { :phrase => 'phrase started with', :links => [ { :title => 'title of url', :url => 'target url' }, ... ] }
+          keywords = (config['redmine'] && config['redmine']['keywords']) || ["refs", "fixes"]
+          match = m.match(/^(#{keywords.join('\b|')})(.*)$/i)
+          return m unless match
+          r = { :phrase => match[1] }
+          captures = match[2].split(/[\s\&\,]+/).map { |m| (m =~ /(\d+)/) ? $1 : m }.reject { |c| c.empty? }
+          r[:links] = captures.map { |mn| { :title => "##{mn}", :url => "#{url}/issues/show/#{mn}" } }
+          r
+        end },
       :bugzilla => { :search_for => /\bBUG\s*(\d+)/i, :replace_with => '#{url}/show_bug.cgi?id=\1' },
       :fogbugz => { :search_for => /\bbugzid:\s*(\d+)/i, :replace_with => '#{url}\1' }
     }.freeze
+    MAX_LINE_LENGTH = 512
     MAX_COMMITS_PER_ACTION = 10000
     HANDLED_COMMITS_FILE = 'previously.txt'.freeze
     NEW_HANDLED_COMMITS_FILE = 'previously_new.txt'.freeze
@@ -64,17 +71,13 @@ module GitCommitNotifier
     end
 
     def lines_per_diff
-      config['lines_per_diff']
+      @config['lines_per_diff']
     end
 
-    def ignore_whitespace?
+    def ignore_whitespaces?
       @config['ignore_whitespace'].nil? || @config['ignore_whitespace']
     end
 
-    def skip_lines?
-      lines_per_diff && (@lines_added >= lines_per_diff)
-    end
-
     def add_separator
       @diff_result << '<tr class="sep"><td class="sep" colspan="3" title="Unchanged content skipped between diff. blocks">&hellip;</td></tr>'
     end
@@ -84,7 +87,6 @@ module GitCommitNotifier
     end
 
     def add_line_to_result(line, escape)
-      @lines_added += 1
       klass = line_class(line)
       content = (escape == :escape) ? escape_content(line[:content]) : line[:content]
       padding = '&nbsp;' if klass != ''
@@ -155,7 +157,8 @@ module GitCommitNotifier
       end
 
       file_name = @current_file_name
-
+      
+      # TODO: these filenames, etc, should likely be properly html escaped
       if config['link_files']
         file_name = if config["link_files"] == "gitweb" && config["gitweb"]
           "<a href='#{config['gitweb']['path']}?p=#{Git.repo_name}.git;f=#{file_name};h=#{@current_sha};hb=#{@current_commit}'>#{file_name}</a>"
@@ -163,10 +166,18 @@ module GitCommitNotifier
           "<a href='#{config['gitorious']['path']}/#{config['gitorious']['project']}/#{config['gitorious']['repository']}/blobs/#{branch_name}/#{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>"
+        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>"
+          else
+            "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name.gsub(".", "_")}/#{@current_commit}/tree/#{file_name}'>#{file_name}</a>"
+          end
+        elsif config["link_files"] == "redmine" && config["redmine"]
+          "<a href='#{config['redmine']['path']}/projects/#{config['redmine']['project'] || Git.repo_name}/repository/revisions/#{@current_commit}/entry/#{file_name}'>#{file_name}</a>"
         else
           file_name
         end
-    end
+      end
 
       header = "#{op} #{binary}file #{file_name}"
       "<h2>#{header}</h2>\n"
@@ -184,19 +195,26 @@ module GitCommitNotifier
 
     def add_changes_to_result
       return if @current_file_name.nil?
+      
+      @lines_added = 0
       @diff_result << operation_description
       if !@diff_lines.empty? && !@too_many_files
         @diff_result << '<table>'
         removals = []
         additions = []
-        @diff_lines.each_with_index do |line, index|
-          if skip_lines?
-            add_skip_notification
-            break
-          end
+        
+        lines = if lines_per_diff.nil?
+          line_budget = nil
+          @diff_lines
+        else
+          line_budget = lines_per_diff - @lines_added
+          @diff_lines.slice(0, line_budget)
+        end
+        
+        lines.each_with_index do |line, index|
           removals << line if line[:op] == :removal
           additions << line if line[:op] == :addition
-          if line[:op] == :unchanged || index == @diff_lines.size - 1 # unchanged line or end of block, add prev lines to result
+          if line[:op] == :unchanged || index == lines.size - 1 # unchanged line or end of block, add prev lines to result
             if removals.size > 0 && additions.size > 0 # block of removed and added lines - perform intelligent diff
               add_block_to_results(lcs_diff(removals, additions), :dont_escape)
             else # some lines removed or added - no need to perform intelligent diff
@@ -204,14 +222,17 @@ module GitCommitNotifier
             end
             removals = []
             additions = []
-            if index > 0 && index != @diff_lines.size - 1
-              prev_line = @diff_lines[index - 1]
+            if index > 0 && index != lines.size - 1
+              prev_line = lines[index - 1]
               add_separator unless lines_are_sequential?(prev_line, line)
             end
             add_line_to_result(line, :escape) if line[:op] == :unchanged
           end
-
+          @lines_added += 1
         end
+        
+        add_skip_notification if !line_budget.nil? && line_budget < @diff_lines.size
+
         @diff_result << '</table>'
         @diff_lines = []
       end
@@ -424,10 +445,50 @@ module GitCommitNotifier
     def merge_commit?(commit_info)
       ! commit_info[:merge].nil?
     end
+    
+    def truncate_long_lines(text)
+      StringIO.open("", "w") do |output|
+        # Match encoding of output string to that of input string
+        output.string.force_encoding(text.encoding) if output.string.respond_to?(:force_encoding)
+
+        input = StringIO.new(text, "r")
+        input.each_line "\n" do |line|
+          if line.length > MAX_LINE_LENGTH && MAX_LINE_LENGTH >= 9
+            # Truncate the line
+            line.slice!(MAX_LINE_LENGTH-3..-1)
+
+            # Ruby < 1.9 doesn't know how to slice between
+            # characters, so deal specially with that case
+            # so that we don't truncate in the middle of a UTF8 sequence,
+            # which would be invalid.
+            if !line.respond_to?(:force_encoding)
+              # If the last remaining character is part of a UTF8 multibyte character,
+              # keep truncating until we go past the start of a UTF8 character.
+              # This assumes that this is a UTF8 string, which may be a false assumption
+              # unless somebody has taken care to check the encoding of the source file.
+              # We truncate at most 6 additional bytes, which is the length of the longest
+              # UTF8 sequence
+              6.times do
+                c = line[-1, 1].to_i
+                break if (c & 0x80) == 0      # Last character is plain ASCII: don't truncate
+                line.slice!(-1, 1)            # Truncate character
+                break if (c & 0xc0) == 0xc0   # Last character was the start of a UTF8 sequence, so we can stop now
+              end
+            end
+
+            # Append three dots to the end of line to indicate it's been truncated
+            # (avoiding ellipsis character so as not to introduce more encoding issues)
+            line << "...\n"
+          end
+          output << line
+        end
+        output.string
+      end
+    end
 
     def diff_for_commit(commit)
       @current_commit = commit
-      raw_diff = Git.show(commit, ignore_whitespace?)
+      raw_diff = truncate_long_lines(Git.show(commit, :ignore_whitespaces => ignore_whitespaces?))
       raise "git show output is empty" if raw_diff.empty?
 
       commit_info = extract_commit_info_from_git_show_output(raw_diff)
@@ -457,6 +518,10 @@ module GitCommitNotifier
           "<a href='#{config['trac']['path']}/#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
         elsif config["link_files"] == "cgit" && config["cgit"]
           "<a href='#{config['cgit']['path']}/#{config['cgit']['project']}/commit/?id=#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
+        elsif config["link_files"] == "gitlabhq" && config["gitlabhq"]
+          "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name.gsub(".", "_")}/commits/#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
+        elsif config["link_files"] == "redmine" && config["redmine"]
+          "<a href='#{config['redmine']['path']}/projects/#{config['redmine']['project'] || Git.repo_name}/repository/revisions/#{commit_info[:commit]}'>#{commit_info[:commit]}</a>"
         else
           " #{commit_info[:commit]}"
         end
@@ -504,13 +569,12 @@ module GitCommitNotifier
         []
       else
         log = Git.log(rev1, rev2)
-        log.scan(/^commit\s([a-f0-9]+)/).map { |a| a.first }
+        log.scan(/^commit\s([a-f0-9]+)/).map { |a| a.first }.reverse
       end
 
       commits = check_handled_commits(commits)
 
       commits.each do |commit|
-        @lines_added = 0  unless config["group_email_by_push"]
         begin
           commit_result = diff_for_commit(commit)
           next  if commit_result.nil?
@@ -539,9 +603,11 @@ module GitCommitNotifier
       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
+        search_for = pm_def[:search_for]
+        search_for = search_for.kind_of?(Proc) ? search_for.call(@config) : search_for
         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)
+        replace_with = replace_with.kind_of?(Proc) ? lambda { |m| pm_def[:replace_with].call(m, url, @config) } : replace_with.gsub('#{url}', url)
+        message_replace!(message, search_for, replace_with)
       end
       message
     end

data/lib/git_commit_notifier/emailer.rb

@@ -3,7 +3,7 @@ require 'premailer'
 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
+  PARAMETERS = %w[project_path recipient from_address from_alias subject text_message html_message repo_name ref_name old_rev new_rev].freeze
 
   def config
     @@config
@@ -43,8 +43,11 @@ class GitCommitNotifier::Emailer
 
   def mail_html_message
     html = GitCommitNotifier::Emailer.template.result(binding)
-    premailer = Premailer.new(html, :with_html_string => true, :adapter => :nokogiri)
-    premailer.to_inline_css
+    if config['expand_css'].nil? || config['expand_css']
+      premailer = Premailer.new(html, :with_html_string => true, :adapter => :nokogiri)
+      html = premailer.to_inline_css
+    end
+    html
   end
 
   def boundary
@@ -78,10 +81,13 @@ class GitCommitNotifier::Emailer
     main_smtp.start( settings['domain'],
                     settings['user_name'], settings['password'], settings['authentication']) do |smtp|
 
-      recp = @recipient.split(",")
-      smtp.open_message_stream(@from_address, recp) do |f|
+      recipients = @recipient.dup
+      recipients.force_encoding('ASCII-8BIT') if recipients.respond_to?(:force_encoding)
+      recipients = recipients.split(",")
+      smtp.open_message_stream(@from_address, recipients) do |f|
         content.each do |line|
-          f.puts line
+          line.force_encoding('ASCII-8BIT') if line.respond_to?(:force_encoding)
+          f.print(line, "\r\n")
         end
       end
     end
@@ -94,7 +100,9 @@ class GitCommitNotifier::Emailer
     }.merge(options || {})
     command = "#{sendmail_settings['location']} #{sendmail_settings['arguments']}"
     IO.popen(command, "w+") do |f|
-      f.write(content.join("\n"))
+      content.each do |line|
+          f.print(line, "\r\n")
+      end
       f.flush
     end
   end
@@ -110,27 +118,37 @@ class GitCommitNotifier::Emailer
     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}>"
+    
+    plaintext = if config['add_plaintext'].nil? || config['add_plaintext']
+      @text_message
+    else
+      "Plain text part omitted. Consider setting add_plaintext in configuration."
+    end
 
     content = [
         "From: #{from}",
         "#{to_tag}: #{quote_if_necessary(@recipient, 'utf-8')}",
         "Subject: #{quote_if_necessary(@subject, 'utf-8')}",
         "X-Mailer: git-commit-notifier",
+        "X-Git-Repository: #{@repo_name}",
         "X-Git-Refname: #{@ref_name}",
         "X-Git-Oldrev: #{@old_rev}",
         "X-Git-Newrev: #{@new_rev}",
         "Mime-Version: 1.0",
-        "Content-Type: multipart/alternative; boundary=#{boundary}\n\n\n",
+        "Content-Type: multipart/alternative; boundary=#{boundary}",
+        "",
         "--#{boundary}",
         "Content-Type: text/plain; charset=utf-8",
-        "Content-Transfer-Encoding: 8bit",
-        "Content-Disposition: inline\n\n\n",
-        @text_message,
-        "\n--#{boundary}",
+        "Content-Transfer-Encoding: quoted-printable",
+        "Content-Disposition: inline",
+        "",
+        encode_quoted_printable_message(plaintext),
+        "--#{boundary}",
         "Content-Type: text/html; charset=utf-8",
-        "Content-Transfer-Encoding: 8bit",
-        "Content-Disposition: inline\n\n\n",
-        mail_html_message,
+        "Content-Transfer-Encoding: quoted-printable",
+        "Content-Disposition: inline",
+        "",
+        encode_quoted_printable_message(mail_html_message),
         "--#{boundary}--"]
 
     if @recipient.empty?
@@ -147,6 +165,45 @@ class GitCommitNotifier::Emailer
     end
   end
 
+  # Convert a message into quoted printable encoding,
+  # limiting line length to 76 characters per spec
+  # Encoding messages in this way ensures that they
+  # won't violate rules for maximum line length, which
+  # can result in the MTA breaking lines at inconvenient points,
+  # such as in the middle of UTF8 characters.
+  def encode_quoted_printable_message(text)
+    StringIO.open("", "w") do |output|
+      # Character encoding of output string can be plain US-ASCII since quoted-printable is plain ASCII
+      output.string.force_encoding("US-ASCII") if output.string.respond_to?(:force_encoding)
+      
+      line_max = 76
+      line_len = 0
+
+      input = StringIO.new(text, "r")
+      input.each_byte do |b|
+        case (b)
+        when 9, 32..60, 62..126
+          if line_len >= line_max - 1
+            output << "=\r\n"
+            line_len = 0
+          end
+          output << b.chr
+          line_len += 1
+        else
+          if line_len >= line_max - 3
+            output << "=\r\n"
+            line_len = 0
+          end
+          output << "=%02X" % b
+          line_len += 3
+        end
+      end
+
+      output << "=\r\n" if line_len > 0
+      output.string
+    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)

data/lib/git_commit_notifier/executor.rb

@@ -2,8 +2,13 @@
 
 require 'git_commit_notifier'
 
+# Git commit notifier namespace
 module GitCommitNotifier
+  # binaries code
   class Executor
+    # runs git commit notifier life
+    # @param [Array(String)] args Command line arguments
+    # @return [nil] Nothing
     def self.run!(args)
       case args.length
       when 0
@@ -24,6 +29,7 @@ module GitCommitNotifier
       else
         GitCommitNotifier::CommitHook.run args.first, args[1], args[2], args[3]
       end
+      nil
     end
   end
 end

data/lib/git_commit_notifier/git.rb

@@ -1,5 +1,9 @@
+# Git methods
 class GitCommitNotifier::Git
   class << self
+    # Runs specified command.
+    # @return (String) Shell command STDOUT (forced to UTF-8)
+    # @raise [ArgumentError] when command exits with nonzero status.
     def from_shell(cmd)
       r = `#{cmd}`
       raise ArgumentError.new("#{cmd} failed") unless $?.exitstatus.zero?
@@ -7,19 +11,38 @@ class GitCommitNotifier::Git
       r
     end
 
-    def show(rev, ignore_whitespace)
+    # runs `git show`
+    # @note uses "--pretty=fuller" option.
+    # @return [String] Its output
+    # @see from_shell
+    # @param [String] rev Revision
+    # @param [Hash] opts Options
+    # @option opts [Boolean] :ignore_whitespaces Ignore whitespaces or not
+    def show(rev, opts = {})
       gitopt = ""
       gitopt += " --pretty=fuller"
-      gitopt += " -w" if ignore_whitespace
+      gitopt += " -w" if opts[:ignore_whitespaces]
       data = from_shell("git show #{rev.strip}#{gitopt}")
       data
     end
 
+    # runs `git log`
+    # @note uses "--pretty=fuller" option.
+    # @return [String] Its output
+    # @see from_shell
+    # @param [String] rev1 First revision
+    # @param [String] rev2 Second revision
     def log(rev1, rev2)
       data = from_shell("git log --pretty=fuller #{rev1}..#{rev2}").strip
       data
     end
 
+    # runs `git log` and extract filenames only
+    # @note uses "--pretty=fuller" and "--name-status" options.
+    # @return [Array(String)] File names
+    # @see from_shell
+    # @param [String] rev1 First revision
+    # @param [String] rev2 Second revision
     def changed_files(rev1, rev2)
       output = ""
       lines = from_shell("git log #{rev1}..#{rev2} --name-status --pretty=oneline")
@@ -59,6 +82,8 @@ class GitCommitNotifier::Git
 
     def mailing_list_address
       from_shell("git config hooks.mailinglist").strip
+    rescue ArgumentError
+      nil
     end
   end
 end

data/spec/lib/git_commit_notifier/commit_hook_spec.rb

@@ -75,7 +75,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, true) { IO.read(FIXTURES_PATH + "git_show_#{rev}") }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + "git_show_#{rev}") }
     end
   end
 
@@ -104,10 +104,10 @@ describe GitCommitNotifier::CommitHook do
   end
 
   describe :run do
-    it "should report error when no recipients specified" do
+    it "should report informational message when no recipients specified" do
       mock(File).exists?(:noconfig) { false }
       mock(GitCommitNotifier::Git).mailing_list_address { nil }
-      mock(GitCommitNotifier::CommitHook).show_error(/recipient/)
+      mock(GitCommitNotifier::CommitHook).info(/recipient/)
       GitCommitNotifier::CommitHook.run(:noconfig, :rev1, :rev2, 'master')
     end
   end

data/spec/lib/git_commit_notifier/diff_to_html_spec.rb

@@ -129,9 +129,9 @@ describe GitCommitNotifier::DiffToHtml do
     mock(GitCommitNotifier::Git).changed_files('7e4f6b4', '4f13525') { [] }
     mock(GitCommitNotifier::Git).log(REVISIONS.first, REVISIONS.last) { IO.read(FIXTURES_PATH + 'git_log') }
     REVISIONS.each do |rev|
-      mock(GitCommitNotifier::Git).show(rev, true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
     end
-
+    
     diff = GitCommitNotifier::DiffToHtml.new
     mock(diff).check_handled_commits(anything) { |commits| commits }
     diff.diff_between_revisions REVISIONS.first, REVISIONS.last, 'testproject', 'master'
@@ -142,22 +142,16 @@ describe GitCommitNotifier::DiffToHtml do
       html.should_not be_include('@@') # diff correctly processed
     end
 
-    # first commit
-    hp = Nokogiri::HTML diff.result.first[:html_content]
-    (hp/"table").should have(2).tables # 2 files updated - one table for each of the files
+    # second commit - 51b986619d88f7ba98be7d271188785cbbb541a0
+    hp = Nokogiri::HTML diff.result[1][:html_content]
+    (hp/"table").should have(3).tables # 3 files updated
     (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
-        td.parent.search('td')[1].inner_text.should == '2' # right
-        td.parent.search('td')[2].inner_html.should == "require 'iconv'" # change
+      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
 
-    # second commit
-    hp = Nokogiri::HTML diff.result[1][:html_content]
-    (hp/"table").should have(1).table # 1 file updated
-
     # third commit - dce6ade4cdc2833b53bd600ef10f9bce83c7102d
     hp = Nokogiri::HTML diff.result[2][:html_content]
     (hp/"h2").should have(6).headers # 6 files in commit
@@ -167,13 +161,19 @@ describe GitCommitNotifier::DiffToHtml do
     (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
+    # fourth commit
     hp = Nokogiri::HTML diff.result[3][:html_content]
-    (hp/"table").should have(3).tables # 3 files updated
+    (hp/"table").should have(1).table # 1 file updated
+
+    # fifth commit
+    hp = Nokogiri::HTML diff.result[4][:html_content]
+    (hp/"table").should have(2).tables # 2 files updated - one table for each of the files
     (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
+      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
   end
@@ -182,7 +182,7 @@ describe GitCommitNotifier::DiffToHtml do
     first_rev, last_rev = %w[ 0000000000000000000000000000000000000000 9b15cebcc5434e27c00a4a2acea43509f9faea21 ]
     mock(GitCommitNotifier::Git).branch_commits('rvm') { %w[ ff037a73fc1094455e7bbf506171a3f3cf873ae6 ] }
     %w[ ff037a73fc1094455e7bbf506171a3f3cf873ae6 ].each do |rev|
-      mock(GitCommitNotifier::Git).show(rev, true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
+      mock(GitCommitNotifier::Git).show(rev, :ignore_whitespaces => true) { IO.read(FIXTURES_PATH + 'git_show_' + rev) }
     end
     diff = GitCommitNotifier::DiffToHtml.new
     mock(diff).check_handled_commits(anything) { |commits| commits }

data/spec/lib/git_commit_notifier/git_spec.rb

@@ -15,18 +15,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} --pretty=fuller -w") { expected }
-      GitCommitNotifier::Git.show(SAMPLE_REV, true).should == expected
+      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespaces => true).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} --pretty=fuller") { expected }
-      GitCommitNotifier::Git.show(SAMPLE_REV, false).should == expected
+      GitCommitNotifier::Git.show(SAMPLE_REV, :ignore_whitespaces => false).should == expected
     end
 
     it "should strip given revision" do
       mock(GitCommitNotifier::Git).from_shell("git show #{SAMPLE_REV} --pretty=fuller -w")
-      GitCommitNotifier::Git.show("#{SAMPLE_REV}\n", true)
+      GitCommitNotifier::Git.show("#{SAMPLE_REV}\n", :ignore_whitespaces => true)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-commit-notifier
 version: !ruby/object:Gem::Version
-  version: 0.10.5
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-06 00:00:00.000000000 Z
+date: 2011-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
-  requirement: &70277632158420 !ruby/object:Gem::Requirement
+  requirement: &70202081729720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70277632158420
+  version_requirements: *70202081729720
 - !ruby/object:Gem::Dependency
   name: nntp
-  requirement: &70277632157800 !ruby/object:Gem::Requirement
+  requirement: &70202081729240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70277632157800
+  version_requirements: *70202081729240
 - !ruby/object:Gem::Dependency
   name: premailer
-  requirement: &70277632157260 !ruby/object:Gem::Requirement
+  requirement: &70202081728720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -50,10 +50,10 @@ dependencies:
         version: 1.7.2
   type: :runtime
   prerelease: false
-  version_requirements: *70277632157260
+  version_requirements: *70202081728720
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70277632156160 !ruby/object:Gem::Requirement
+  requirement: &70202081727760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -61,10 +61,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70277632156160
+  version_requirements: *70202081727760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70277632155540 !ruby/object:Gem::Requirement
+  requirement: &70202081727220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -75,10 +75,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70277632155540
+  version_requirements: *70202081727220
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70277632154480 !ruby/object:Gem::Requirement
+  requirement: &70202081726400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -89,10 +89,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *70277632154480
+  version_requirements: *70202081726400
 - !ruby/object:Gem::Dependency
   name: code-cleaner
-  requirement: &70277632153000 !ruby/object:Gem::Requirement
+  requirement: &70202081725280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277632153000
+  version_requirements: *70202081725280
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &70277632152400 !ruby/object:Gem::Requirement
+  requirement: &70202081724720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277632152400
+  version_requirements: *70202081724720
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &70277632151660 !ruby/object:Gem::Requirement
+  requirement: &70202081724240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277632151660
+  version_requirements: *70202081724240
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70277632150500 !ruby/object:Gem::Requirement
+  requirement: &70202081723720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -133,10 +133,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70277632150500
+  version_requirements: *70202081723720
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70277632243320 !ruby/object:Gem::Requirement
+  requirement: &70202081723240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -144,10 +144,10 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *70277632243320
+  version_requirements: *70202081723240
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70277632241680 !ruby/object:Gem::Requirement
+  requirement: &70202081722760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.7.3
   type: :development
   prerelease: false
-  version_requirements: *70277632241680
+  version_requirements: *70202081722760
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70277632240700 !ruby/object:Gem::Requirement
+  requirement: &70202081858160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -166,7 +166,7 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *70277632240700
+  version_requirements: *70202081858160
 description: This git commit notifier sends html mails with nice diffs for every changed
   file.
 email: bodo@bitboxer.de
@@ -223,7 +223,7 @@ files:
 - spec/spec_helper.rb
 - template/email.html.erb
 - template/styles.css
-homepage: http://github.com/bitboxer/git-commit-notifier
+homepage: http://bitboxer.github.com/git-commit-notifier/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -237,7 +237,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -486808045600569914
+      hash: -3538399353583787974
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Sends git commit messages with diffs