git-commit-mailer 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d41e58adc35fd16bcfca2e295036b47397d548d3
-  data.tar.gz: 4ed5b675e95ceb15e26a06197cdb45951abd0200
+  metadata.gz: 136f22114f43ec2e9948d128a9070084b3af3b0b
+  data.tar.gz: 11441281f87e1d875665e935939d5af2eb66c701
 SHA512:
-  metadata.gz: 487ef516f9c79d6c1648c0ca2f61d055db5b747214de9fbd1b69e52f70b7f0092eb3bb50dbff02c312ee11a4d28b4d543d3793ec07168fb8e8197db42f937a7d
-  data.tar.gz: 7fddf6a57b2bcf15842033fff29cff2def697f632c323ce54083b6e42524d64ca7d6032ccd229d730186e0b10de49ec9424903db2b84f20bd97b74b77d528b49
+  metadata.gz: 2f6c8edf2e5aebffd8132bdebe699570c2cf0027ce3032f6e1d3d22fc3560b68016312d78ececfd12ff79e5157080c1050e406f1727477123b1b35dc63c2b219
+  data.tar.gz: 508e1476fb0050113ccbccde483a0209eb173bbebbb216bb69d2c3bf0b2a30a50cf40566eaf7683511b46e130127b242d530645e016a45c70f29ceb597ab3892

data/doc/text/news.md

@@ -1,5 +1,30 @@
 # News
 
+## 1.0.4 - 2016-10-07 {#version-1-0-4}
+
+### Improvements
+
+  * [GitHub] Supported formatting merge message.
+
+  * [GitHub] Supported `GH-NNN` auto link.
+
+  * Supported diff in a line.
+
+  * Improved color schema.
+
+  * Supported special characters such as "," in author name.
+
+  * Supported showing diff in merge commit.
+
+  * [GitLab] Supported GitLab Wiki as a repository browser.
+
+### Fixes
+
+  * Fixed a bug that `@domain` in email address is handled as mention.
+
+  * Fixed a bug that commit ID like string in email address is handled
+    as commit ID.
+
 ## 1.0.3 - 2015-06-09 {#version-1-0-3}
 
 ### Improvements

data/git-commit-mailer.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "diff-lcs"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "test-unit"

data/lib/git-commit-mailer.rb

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
-#
 # Copyright (C) 2009  Ryo Onodera <onodera@clear-code.com>
-# Copyright (C) 2012-2014  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012-2016  Kouhei Sutou <kou@clear-code.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -273,7 +271,7 @@ class GitCommitMailer
 
     def make_parser(options)
       OptionParser.new do |parser|
-        parser.banner += "TO"
+        parser.banner += " TO"
 
         add_repository_options(parser, options)
         add_email_options(parser, options)
@@ -304,7 +302,7 @@ class GitCommitMailer
         options.reference = reference
       end
 
-      available_software = ["github", "github-wiki", "gitlab"]
+      available_software = ["github", "github-wiki", "gitlab", "gitlab-wiki"]
       label = available_software.join(", ")
       parser.on("--repository-browser=SOFTWARE",
                 available_software,
@@ -559,11 +557,22 @@ class GitCommitMailer
       if /\A[^\s<]+@[^\s>]\z/ =~ @from
         @from
       else
-        "#{info.author_name} <#{@from}>"
+        "#{format_name(info.author_name)} <#{@from}>"
+      end
+    else
+      "#{format_name(info.author_name)} <#{info.author_email}>"
+    end
+  end
+
+  def format_name(name)
+    case name
+    when /[,"\\]/
+      escaped_name = name.gsub(/["\\]/) do |special_character|
+        "\\#{special_character}"
       end
+      "\"#{escaped_name}\""
     else
-      # return "#{info.author_name}@#{@from_domain}".sub(/@\z/, '') if @from_domain
-      "#{info.author_name} <#{info.author_email}>"
+      name
     end
   end
 
@@ -1037,8 +1046,8 @@ EOF
         end
 
         merge_message = "Merged #{merge_commit.short_revision}: #{merge_commit.subject}"
-        if not is_traversing_first_parent and not commit_info.merge_status.index(merge_message)
-          commit_info.merge_status << merge_message
+        if not is_traversing_first_parent and not commit_info.merge_messages.index(merge_message)
+          commit_info.merge_messages << merge_message
           commit_info.merge_commits << merge_commit
         end
 

data/lib/git-commit-mailer/commit-info.rb

@@ -44,7 +44,7 @@ class GitCommitMailer
     attr_reader :added_files, :copied_files, :deleted_files, :updated_files
     attr_reader :renamed_files, :type_changed_files, :diffs
     attr_reader :subject, :author_name, :author_email, :date, :summary
-    attr_accessor :merge_status
+    attr_accessor :merge_messages
     attr_writer :reference
     attr_reader :merge_commits
     def initialize(mailer, reference, revision)
@@ -64,7 +64,7 @@ class GitCommitMailer
       parse_file_status
       parse_diff
 
-      @merge_status = []
+      @merge_messages = []
       @merge_commits = []
     end
 
@@ -185,7 +185,7 @@ class GitCommitMailer
       @diffs = []
       output = []
       n_bytes = 0
-      git("log -n 1 --pretty=format:'' -C -p #{@revision}") do |io|
+      git("log -n 1 --pretty=format:'' -C --cc -p #{@revision}") do |io|
         io.each_line do |line|
           n_bytes += line.bytesize
           break if n_bytes > mailer.max_diff_size

data/lib/git-commit-mailer/file-diff.rb

@@ -83,9 +83,14 @@ class GitCommitMailer
 
     def parse_header(lines)
       line = lines.shift.strip
-      if line =~ /\Adiff --git ("?a\/.*) ("?b\/.*)/
+      case line
+      when /\Adiff --git ("?a\/.*) ("?b\/.*)/
         @from_file = extract_file_path($1)
         @to_file = extract_file_path($2)
+      when /\Adiff --(?:combined|cc) (.*?)/
+        path = CommitInfo.unescape_file_path($1)
+        @from_file = path
+        @to_file = path
       else
         raise "Unexpected diff header format: #{line}"
       end
@@ -116,6 +121,9 @@ class GitCommitMailer
       when /\Aindex ([0-9a-f]{7,})\.\.([0-9a-f]{7,})/
         @old_blob = $1
         @new_blob = $2
+      when /\Aindex ([0-9a-f]{7,}),([0-9a-f]{7,}\.\.[0-9a-f]{7,})/
+        @old_blob = $1
+        @new_blob = $2
       else
         return false
       end

data/lib/git-commit-mailer/html-mail-body-formatter.rb

@@ -18,6 +18,8 @@
 
 require "digest/md5"
 
+require "diff/lcs"
+
 class GitCommitMailer
   class HTMLMailBodyFormatter < MailBodyFormatter
     include ERB::Util
@@ -42,18 +44,18 @@ class GitCommitMailer
       <%= dd(h(@mailer.format_time(@info.date))) %>
       <%= dt("New Revision") %>
       <%= dd(format_revision) %>
-<% unless @info.merge_status.empty? %>
+<% unless @info.merge_messages.empty? %>
       <%= dt("Merge") %>
       <%= dd_start %>
         <ul>
-<%   @info.merge_status.each do |status| %>
-          <li><%= h(status) %></li>
+<%   @info.merge_messages.each do |message| %>
+          <li><%= format_message(message) %></li>
 <%   end %>
         </ul>
       </dd>
 <% end %>
       <%= dt("Message") %>
-      <%= dd(format_summary(@info.summary.strip)) %>
+      <%= dd(pre(format_message(@info.summary))) %>
 <%= format_files("Added",        @info.added_files) %>
 <%= format_files("Copied",       @info.copied_files) %>
 <%= format_files("Removed",      @info.deleted_files) %>
@@ -72,7 +74,7 @@ class GitCommitMailer
       revision = @info.revision
       url = commit_url
       if url
-        formatted_revision = "<a href=\"#{h(url)}\">#{h(revision)}</a>"
+        formatted_revision = tag("a", {"href" => url}, h(revision))
       else
         formatted_revision = h(revision)
       end
@@ -170,6 +172,8 @@ class GitCommitMailer
       from_line_column = ""
       to_line_column = ""
       content_column = ""
+      content_lines = []
+
       file_path = diff.file_path
       diff.changes.each do |type, line_number, line|
         case type
@@ -179,6 +183,8 @@ class GitCommitMailer
                                                            from_line_number)
           to_line_column << span_line_number_hunk_header(file_path, :to,
                                                          to_line_number)
+
+          flush_content_lines(content_column, content_lines)
           case line
           when /\A(@@[\s0-9\-+,]+@@\s*)(.+)(\s*)\z/
             hunk_info = $1
@@ -187,50 +193,152 @@ class GitCommitMailer
           else
             formatted_line = h(line)
           end
-          content_column << span_diff_hunk_header(formatted_line)
+          content_column << span_diff_hunk_header(formatted_line) << "\n"
         when :added
           from_line_column << span_line_number_nothing
           to_line_column << span_line_number_added(file_path, line_number)
-          content_column << span_diff_added(h(line))
+          content_lines << [:added, line]
         when :deleted
           from_line_column << span_line_number_deleted(file_path, line_number)
           to_line_column << span_line_number_nothing
-          content_column << span_diff_deleted(h(line))
+          content_lines << [:deleted, line]
         when :not_changed
           from_line_number, to_line_number = line_number
           from_line_column << span_line_number_not_changed(file_path, :from,
                                                            from_line_number)
           to_line_column << span_line_number_not_changed(file_path, :to,
                                                          to_line_number)
-          content_column << span_diff_not_changed(h(line))
+          flush_content_lines(content_column, content_lines)
+          content_column << span_diff_not_changed(h(line)) << "\n"
         end
         from_line_column << "\n"
         to_line_column << "\n"
-        content_column << "\n"
       end
+      flush_content_lines(content_column, content_lines)
       [from_line_column, to_line_column, content_column]
     end
 
-    def format_summary(summary)
+    def flush_content_lines(column, lines)
+      return if lines.empty?
+
+      added_lines = []
+      deleted_lines = []
+      lines.each do |type, line|
+        if type == :added
+          added_lines << line
+        else
+          deleted_lines << line
+        end
+      end
+
+      if added_lines.size == deleted_lines.size
+        nth_added = 0
+        nth_deleted = 0
+        lines.each do |type, line|
+          if type == :added
+            deleted_line = deleted_lines[nth_added]
+            formatted_added_line = format_added_words(line, deleted_line)
+            column << span_diff_added(formatted_added_line) << "\n"
+            nth_added += 1
+          else
+            added_line = added_lines[nth_deleted]
+            formatted_deleted_line = format_deleted_words(line, added_line)
+            column << span_diff_deleted(formatted_deleted_line) << "\n"
+            nth_deleted += 1
+          end
+        end
+      else
+        lines.each do |type, line|
+          if type == :added
+            column << span_diff_added(h(line)) << "\n"
+          else
+            column << span_diff_deleted(h(line)) << "\n"
+          end
+        end
+      end
+      lines.clear
+    end
+
+    def format_changed_words(from_line, to_line, &formatter)
+      line = h(from_line[0, 1])
+      changed_chars = ""
+
+      flush_changed_chars = lambda do
+        unless changed_chars.empty?
+          line << formatter.call(h(changed_chars))
+          changed_chars.clear
+        end
+      end
+
+      Diff::LCS.sdiff(from_line[1..-1], to_line[1..-1]).each do |diff|
+        action, from, _to = *diff
+        _from_nth, from_char = from
+        next if from_char.nil?
+
+        case action
+        when "="
+          flush_changed_chars.call
+          line << h(from_char)
+        when "!", "-"
+          changed_chars << from_char
+        when "+"
+          flush_changed_chars.call
+        end
+      end
+      flush_changed_chars.call
+
+      line
+    end
+
+    def format_added_words(added_line, deleted_line)
+      format_changed_words(added_line, deleted_line) do |chars|
+        span_diff_added_word(chars)
+      end
+    end
+
+    def format_deleted_words(deleted_line, added_line)
+      format_changed_words(deleted_line, added_line) do |chars|
+        span_diff_deleted_word(chars)
+      end
+    end
+
+    def format_message(message)
+      message = message.strip
       case @mailer.repository_browser
       when "github"
-        format_summary_github(summary)
+        format_message_github(message)
       else
-        pre(h(summary))
+        h(message)
       end
     end
 
+    PATTERN_HTML_SPECIAL_CHARACTER = /['&\"<>]/
+    PATTERN_EMAIL = /[\da-zA-Z\-_]+@[\da-zA-Z\-_.]+/
+    GITHUB_MARKUP_PATTERN_GH_ISSUE = /GH-\d+/
     GITHUB_MARKUP_PATTERN_ISSUE = /\#\d+/
     GITHUB_MARKUP_PATTERN_COMMIT = /[\da-fA-F]{7,}/
     GITHUB_MARKUP_PATTERN_MENTION = /@[\da-zA-Z\-]+/
-    def format_summary_github(summary)
-      formatted_summary = summary.gsub(/
-                                         ['&\"<>]|
-                                         #{GITHUB_MARKUP_PATTERN_ISSUE}|
-                                         #{GITHUB_MARKUP_PATTERN_COMMIT}|
-                                         #{GITHUB_MARKUP_PATTERN_MENTION}
-                                       /x) do |matched|
+    def format_message_github(message)
+      message.gsub(/
+                     #{PATTERN_HTML_SPECIAL_CHARACTER}|
+                     #{PATTERN_EMAIL}|
+                     #{GITHUB_MARKUP_PATTERN_GH_ISSUE}|
+                     #{GITHUB_MARKUP_PATTERN_ISSUE}|
+                     #{GITHUB_MARKUP_PATTERN_COMMIT}|
+                     #{GITHUB_MARKUP_PATTERN_MENTION}
+                   /x) do |matched|
         case matched
+        when /\A#{PATTERN_HTML_SPECIAL_CHARACTER}\z/
+          h(matched)
+        when /\A#{PATTERN_EMAIL}\z/
+          h(matched)
+        when /\A#{GITHUB_MARKUP_PATTERN_GH_ISSUE}\z/
+          issue_number = matched.gsub(/\AGH-/, "")
+          tag("a",
+              {
+                "href" => github_issue_url(issue_number),
+              },
+              h(matched))
         when /\A#{GITHUB_MARKUP_PATTERN_ISSUE}\z/
           issue_number = matched.gsub(/\A\#/, "")
           tag("a",
@@ -256,7 +364,6 @@ class GitCommitMailer
           h(matched)
         end
       end
-      pre(formatted_summary)
     end
 
     def github_issue_url(id)
@@ -462,14 +569,28 @@ class GitCommitMailer
 
     def span_deleted_styles
       {
-        "background-color" => "#ffaaaa",
+        "background-color" => "#ffecec",
+        "color"            => "#000000",
+      }
+    end
+
+    def span_deleted_word_styles
+      {
+        "background-color" => "#f8cbcb",
         "color"            => "#000000",
       }
     end
 
     def span_added_styles
       {
-        "background-color" => "#aaffaa",
+        "background-color" => "#eaffea",
+        "color"            => "#000000",
+      }
+    end
+
+    def span_added_word_styles
+      {
+        "background-color" => "#a6f3a6",
         "color"            => "#000000",
       }
     end
@@ -605,6 +726,15 @@ class GitCommitMailer
           content)
     end
 
+    def span_diff_deleted_word(content)
+      tag("span",
+          {
+            "class" => "diff-deleted-word",
+            "style" => span_deleted_word_styles,
+          },
+          content)
+    end
+
     def span_diff_added(content)
       tag("span",
           {
@@ -614,6 +744,15 @@ class GitCommitMailer
           content)
     end
 
+    def span_diff_added_word(content)
+      tag("span",
+          {
+            "class" => "diff-added-word",
+            "style" => span_added_word_styles,
+          },
+          content)
+    end
+
     def span_diff_not_changed(content)
       tag("span",
           {
@@ -632,6 +771,8 @@ class GitCommitMailer
         "#{base_url}#diff-#{file_md5}"
       when "github-wiki"
         commit_file_url_github_wiki(file)
+      when "gitlab-wiki"
+        commit_file_url_gitlab_wiki(file)
       else
         nil
       end

data/lib/git-commit-mailer/mail-body-formatter.rb

@@ -40,6 +40,9 @@ class GitCommitMailer
         return nil if @mailer.gitlab_project_uri.nil?
         revision = @info.revision
         "#{@mailer.gitlab_project_uri}/commit/#{revision}"
+      when "gitlab-wiki"
+        file = (@info.updated_files + @info.added_files).first
+        commit_file_url_gitlab_wiki(file)
       else
         nil
       end
@@ -66,5 +69,17 @@ class GitCommitMailer
       revision = @info.revision
       "#{base_url}/#{user}/#{repository}/wiki/#{page_name_in_url}/#{revision}"
     end
+
+    def commit_file_url_gitlab_wiki(file)
+      return nil if file.nil?
+
+      gitlab_project_uri = @mailer.gitlab_project_uri
+      return nil if gitlab_project_uri.nil?
+
+      page_name = file.gsub(/\.[^.]+\z/, "")
+      page_name_in_url = ERB::Util.u(page_name)
+      revision = @info.revision
+      "#{gitlab_project_uri}/wikis/#{page_name_in_url}?version_id=#{revision}"
+    end
   end
 end

data/lib/git-commit-mailer/text-mail-body-formatter.rb

@@ -31,9 +31,9 @@ class GitCommitMailer
   New Revision: <%= @info.revision %>
 <%= format_commit_url %>
 
-<% unless @info.merge_status.empty? %>
-<%   @info.merge_status.each do |status| %>
-  <%= status %>
+<% unless @info.merge_messages.empty? %>
+<%   @info.merge_messages.each do |message| %>
+  <%= message %>
 <%   end %>
 
 <% end %>

data/lib/git-commit-mailer/version.rb

@@ -1,4 +1,4 @@
 class GitCommitMailer
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
   URL = "https://github.com/clear-code/git-commit-mailer"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-commit-mailer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ryo Onodera
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -117,9 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A utility to send commit mails for commits pushed to git repositories.
 test_files: []
-has_rdoc: