git-commit-notifier 0.12.6 → 0.12.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5264a69f6678981a62e65cbcac4455a8ed6efcc3
-  data.tar.gz: 12fe72aa75b6317dc3c2c74f33b21bae00751c61
+  metadata.gz: aa06b0dab1d471d02e72bfa233799193e8f70f24
+  data.tar.gz: 7d3d46cf47943e7ccf971c96b884e9f8e1ae7c78
 SHA512:
-  metadata.gz: 5ceaed33443036a025fdb6fad63c244d9bbe9114e65f4e5850f1fbeba3cbc0ca4ae29e3eb08b4611335be1166b8bca8ce2b6f98e02f1fde731e36f9692b245c0
-  data.tar.gz: 839f75af16900756c0510af9691f43579598868fde4263e08a05edcaad74a58623f633951b757328fe9b9dd772eb836eaf7c5fef3ae458803fc72288e3bb6123
+  metadata.gz: 4d48398f5f1b80f5c5d819bef22da24503415fcc34591b22cecb6d20212db5ba9ea1fbdc555de4fc11a5d4408ff52999daec10e6a04e6185904cf3dc3bdb7501
+  data.tar.gz: a62a8662e05fbe551e9581cce82246834d6d509a55e5d50f2f46c103eb82e8f8ef2809c0161732667cece693c28c1d4b12958935002e7e154963899cb521b216

data/CHANGES.md

@@ -2,6 +2,10 @@
 
 ## Not yet released
 
+## Version 0.12.10
+
+* Commit metalinks in emails.
+
 ## Version 0.12.5-0.12.6
 
 * Fix behaviour when git output is not utf-8.

data/VERSION

@@ -1 +1 @@
-0.12.6
+0.12.10

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

@@ -130,7 +130,7 @@ nntp_settings:
   port: 119
 
 # Decorate files and commit ids with link to a webview. Possible values: none, gitweb,
-# gitorious, cgit, trac, gitlabhq, gitalist, github or redmine
+# gitorious, cgit, trac, gitlabhq, gitalist, github, redmine, or stash
 link_files: none
 
 # If link_files is set to "gitweb", you need to configure the path to your gitweb
@@ -157,6 +157,8 @@ cgit:
 # instance
 trac:
   path: http://example.com/changeset
+# repository: test.git
+# repository defaults to nil (link to trac's default repository)
 
 # If link_files is set to "gitlabhq", you need to configure the path to your gitlabhq
 # instance
@@ -184,6 +186,10 @@ redmine:
 # keywords: [refs, fixes]
 # project defaults to git repository name, keywords defaults to refs, fixes (for use with message_integration)
 
+# if link_files is set to "stash", you need to configure the path to your stash
+# instance
+stash:
+  path: http://stash.example.com
 
 # commit message URL map
 message_map:

data/lib/git_commit_notifier/commit_hook.rb

@@ -45,7 +45,7 @@ module GitCommitNotifier
       end
 
       def add_committer_to_recipient(recipient, committer_email)
-        if email?(committer_email) 
+        if email?(committer_email)
           "#{recipient},#{committer_email}"
         else
           recipient
@@ -105,15 +105,15 @@ module GitCommitNotifier
       # @return [NilClass] nil
       # @see config
       def run(config_name, rev1, rev2, ref_name)
-      
+
         if @start_time.nil?
           @start_time = Time.new
           @start_time_offset = 0
         end
 
         # Load the configuration
-        if File.exists?(config_name) 
-          @config = YAML::load_file(config_name) 
+        if File.exists?(config_name)
+          @config = YAML::load_file(config_name)
         else
           GitCommitNotifier::CommitHook.info("Unable to find configuration file: #{config_name}")
           @config = {}
@@ -255,7 +255,7 @@ module GitCommitNotifier
               :repo_name => repo_name
             )
             webhook.send
-            
+
             @start_time_offset += 1
           end
         else
@@ -288,7 +288,8 @@ module GitCommitNotifier
               :old_rev => rev1,
               :new_rev => rev2,
               :ref_name => ref_name,
-              :repo_name => repo_name
+              :repo_name => repo_name,
+              :message_link => result[:commit_link]
             )
             emailer.send
 
@@ -309,7 +310,7 @@ module GitCommitNotifier
             end
 
             commit_number += 1
-            
+
             @start_time_offset += 1
           end
         end

data/lib/git_commit_notifier/diff_to_html.rb

@@ -211,13 +211,34 @@ module GitCommitNotifier
 
       # TODO: these filenames, etc, should likely be properly html escaped
       file_link = file_name
+      if config['link_files'] && !@file_removed
+        file_link = generate_file_link(file_name)
+      end
+
+      if show_summary?
+        @file_changes << {
+          :file_name => file_name,
+          :text => "#{op} #{binary}file #{file_name}",
+        }
+      end
+
+      "<a name=\"#{file_name}\"></a><h2>#{op} #{binary}file #{file_link}</h2>\n"
+    end
+
+    def generate_file_link(file_name)
       if config['link_files'] && !@file_removed
         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>"
+          if config["trac"]["repository"]
+            "<a href='#{config['trac']['path']}/#{@current_commit}/#{config['trac']['repository']}/#{file_name}'>#{file_name}</a>"
+          else
+            "<a href='#{config['trac']['path']}/#{@current_commit}/#{file_name}'>#{file_name}</a>"
+          end
+        elsif config["link_files"] == "stash" && config["stash"]
+          "<a href='#{config['stash']['path']}/repos/#{config['stash']['repository']}/browse/#{file_name}?at=#{@current_commit}'>#{file_name}</a>"
         elsif config["link_files"] == "cgit" && config["cgit"]
           "<a href='#{config['cgit']['path']}/#{config['cgit']['project'] || "#{Git.repo_name_real}"}/tree/#{file_name}?h=#{branch_name}'>#{file_name}</a>"
         elsif config["link_files"] == "gitlabhq" && config["gitlabhq"]
@@ -240,15 +261,6 @@ module GitCommitNotifier
           file_name
         end
       end
-
-      if show_summary?
-        @file_changes << {
-          :file_name => file_name, 
-          :text => "#{op} #{binary}file #{file_name}",
-        }
-      end
-
-      "<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).
@@ -276,7 +288,7 @@ module GitCommitNotifier
         if @file_renamed
           @diff_result << "<tr class='renamed'>\n<td class='ln'>&nbsp;</td><td class='ln'></td><td>&nbsp;<u>#{@file_renamed_old_name}</u> was renamed to <u>#{@file_renamed_new_name}</u></td></tr>"
         end
-       
+
         removals = []
         additions = []
 
@@ -324,6 +336,7 @@ module GitCommitNotifier
       @binary = false
     end
 
+    RE_DIFF_FILE_NAME_ESCAPED = /^diff --git "a\/(.*)" "?b\//
     RE_DIFF_FILE_NAME = /^diff\s\-\-git\sa\/(.*)\sb\//
     RE_DIFF_SHA       = /^index [0-9a-fA-F]+\.\.([0-9a-fA-F]+)/
 
@@ -355,6 +368,10 @@ module GitCommitNotifier
           file_name = $1
           add_changes_to_result
           @current_file_name = file_name
+        when RE_DIFF_FILE_NAME_ESCAPED then
+          file_name = decode_escaped_filename( $1 )
+          add_changes_to_result
+          @current_file_name = file_name
         when RE_DIFF_SHA then
           @current_sha = $1
         else
@@ -547,7 +564,16 @@ module GitCommitNotifier
     COMMIT_LINK_MAP = {
       :gitweb    => lambda { |config, commit| "<a href='#{config['gitweb']['path']}?p=#{config['gitweb']['project'] || "#{Git.repo_name}.git"};a=commitdiff;h=#{commit}'>#{commit}</a>" },
       :gitorious => lambda { |config, commit| "<a href='#{config['gitorious']['path']}/#{config['gitorious']['project']}/#{config['gitorious']['repository']}/commit/#{commit}'>#{commit}</a>" },
-      :trac      => lambda { |config, commit| "<a href='#{config['trac']['path']}/#{commit}'>#{commit}</a>" },
+      :trac      => lambda { |config, commit|
+        if config['trac']['repository']
+          "<a href='#{config['trac']['path']}/#{commit}/#{config['trac']['repository']}'>#{commit}</a>"
+        else
+          "<a href='#{config['trac']['path']}/#{commit}'>#{commit}</a>"
+        end
+      },
+      :stash     => lambda { |config, commit|
+        "<a href='#{config['stash']['path']}/repos/#{config['stash']['repository']}/commits/#{commit}'>#{commit}</a>"
+      },
       :cgit      => lambda { |config, commit| "<a href='#{config['cgit']['path']}/#{config['cgit']['project'] || "#{Git.repo_name_real}"}/commit/?id=#{commit}'>#{commit}</a>" },
       :gitlabhq  => lambda { |config, commit|
         if config['gitlabhq']['version'] >= 5.0
@@ -575,6 +601,11 @@ module GitCommitNotifier
       COMMIT_LINK_MAP[mode].call(config, commit)
     end
 
+    def extract_link(a_tag)
+      m = /href\s*=\s*["']([^"']+)["']/i.match(a_tag)
+      m && m[1]
+    end
+
     def diff_for_commit(commit)
       @current_commit = commit
       raw_diff = truncate_long_lines(Git.show(commit, :ignore_whitespace => ignore_whitespace))
@@ -603,8 +634,9 @@ module GitCommitNotifier
         changed_files = "Changed files:\n\n#{changed_file_list.uniq.join()}\n"
       end
 
+      commit_link = markup_commit_for_html(commit_info[:commit])
       title = "<dl class=\"title\">"
-      title += "<dt>Commit</dt><dd>#{markup_commit_for_html(commit_info[:commit])}</dd>\n"
+      title += "<dt>Commit</dt><dd>#{commit_link}</dd>\n"
       title += "<dt>Branch</dt><dd>#{CGI.escapeHTML(branch_name)}</dd>\n" if branch_name
 
       title += "<dt>Author</dt><dd>#{CGI.escapeHTML(commit_info[:author])} &lt;#{commit_info[:email]}&gt;</dd>\n"
@@ -650,7 +682,8 @@ module GitCommitNotifier
       {
         :commit_info  => commit_info,
         :html_content => html,
-        :text_content => text
+        :text_content => text,
+        :commit_link  => extract_link( commit_link ),
       }
     end
 
@@ -658,11 +691,12 @@ module GitCommitNotifier
 
       if change_type == :delete
         message = "Remove Lightweight Tag #{tag}"
+        commit_link = markup_commit_for_html(rev)
 
         html = "<dl class='title'>"
         html += "<dt>Tag</dt><dd>#{CGI.escapeHTML(tag)} (removed)</dd>\n"
         html += "<dt>Type</dt><dd>lightweight</dd>\n"
-        html += "<dt>Commit</dt><dd>#{markup_commit_for_html(rev)}</dd>\n"
+        html += "<dt>Commit</dt><dd>#{commit_link}</dd>\n"
         html += "</dl>"
 
         text = "Remove Tag: #{tag}\n"
@@ -690,7 +724,8 @@ module GitCommitNotifier
       @result << {
         :commit_info => commit_info,
         :html_content => html,
-        :text_content => text
+        :text_content => text,
+        :commit_link => extract_link( commit_link )
       }
     end
 
@@ -714,11 +749,12 @@ module GitCommitNotifier
         tag_info = Git.tag_info(ref_name)
 
         message = tag_info[:subject] || "#{change_type == :create ? "Add" : "Update"} Annotated Tag #{tag}"
+        commit_link = markup_commit_for_html(tag_info[:tagobject])
 
         html = "<dl class='title'>"
         html += "<dt>Tag</dt><dd>#{CGI.escapeHTML(tag)} (#{change_type == :create ? "added" : "updated"})</dd>\n"
         html += "<dt>Type</dt><dd>annotated</dd>\n"
-        html += "<dt>Commit</dt><dd>#{markup_commit_for_html(tag_info[:tagobject])}</dd>\n"
+        html += "<dt>Commit</dt><dd>#{commit_link}</dd>\n"
         html += "<dt>Tagger</dt><dd>#{CGI.escapeHTML(tag_info[:taggername])} #{CGI.escapeHTML(tag_info[:taggeremail])}</dd>\n"
 
         message_array = tag_info[:contents].split("\n")
@@ -728,7 +764,7 @@ module GitCommitNotifier
         if config['show_a_shortlog_of_commits_since_the_last_annotated_tag']
           list_of_commits_in_between = Git.list_of_commits_between_current_commit_and_last_tag(ref_name, tag_info[:tagobject])
           if list_of_commits_in_between.length > 0
-            html += "<dt><br/>Commits since the last annotated tag</dt><dd><br/><br/><ul>"                    
+            html += "<dt><br/>Commits since the last annotated tag</dt><dd><br/><br/><ul>"
             list_of_commits_in_between.each do |commit|
               if config['link_files'].to_s != "none"
                 l = markup_commit_for_html(commit[0])
@@ -754,9 +790,10 @@ module GitCommitNotifier
       end
 
       @result << {
-        :commit_info => commit_info,
+        :commit_info  => commit_info,
         :html_content => html,
-        :text_content => text
+        :text_content => text,
+        :commit_link  => extract_link( commit_link )
       }
     end
 
@@ -771,10 +808,10 @@ module GitCommitNotifier
         # The flag unique_to_current_branch passed to new_commits means the
         # opposite: "consider only commits that are unique to this branch"
 
-       	# Note :: In case of creation of a new branch, the oldrev passed by git 
-       	# to the post-receive hook is 00000... which causes the git commit notifier 
-       	# to send out notifications for ALL commits in the repository. Hence we force 
-       	# the "unique_commits_per_branch" config to "true" in such cases, and in other 
+       	# Note :: In case of creation of a new branch, the oldrev passed by git
+       	# to the post-receive hook is 00000... which causes the git commit notifier
+       	# to send out notifications for ALL commits in the repository. Hence we force
+       	# the "unique_commits_per_branch" config to "true" in such cases, and in other
        	# cases, we consider the value from the config file
         if oldrev =~ /^0+$/
           Git.new_commits(oldrev, newrev, ref_name, true)

data/lib/git_commit_notifier/emailer.rb

@@ -9,7 +9,24 @@ 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 reply_to_address commit_date current_date offset_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
+    commit_date
+    current_date
+    offset_date
+    subject
+    text_message
+    html_message
+    repo_name
+    ref_name
+    old_rev
+    new_rev
+    message_link
+  ].freeze
 
   # Gets config.
   # @return [Hash] Configuration

data/lib/git_commit_notifier/escape_helper.rb

@@ -23,4 +23,12 @@ module GitCommitNotifier::EscapeHelper
   def escape_content(s)
     CGI.escapeHTML(expand_tabs(s, 4)).gsub(" ", " ")
   end
+
+  def decode_escaped_filename( filename )
+    filename.gsub( /\\\d\d\d\\\d\d\d/ ) { |match|
+      mb_char_code  = match.split( '\\' )[ 1, 2 ]
+      mb_char_code.map! { |x| x.oct }
+      mb_char_code.pack( 'C*' ).force_encoding( 'UTF-8')
+    }
+  end
 end

data/spec/lib/git_commit_notifier/diff_to_html_spec.rb

@@ -17,6 +17,36 @@ describe GitCommitNotifier::DiffToHtml do
     end
   end
 
+  describe :generate_file_link do
+    it "should generate proper url for stash" do
+      diff = GitCommitNotifier::DiffToHtml.new(
+              "link_files" => "stash",
+              "stash" => {
+                "path" => "http://example.com/projects/TEST",
+                "repository" => "TESTREPO"
+              })
+
+      mock(GitCommitNotifier::Git).rev_type(REVISIONS[1]) { "commit" }
+      mock(GitCommitNotifier::Git).rev_type(REVISIONS[2]) { "commit" }
+      mock(GitCommitNotifier::Git).new_commits(anything, anything, anything, anything) { [REVISIONS[1]] }
+      [REVISIONS[1]].each do |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.diff_between_revisions REVISIONS[1], REVISIONS[2], 'testproject', 'refs/heads/master'
+
+      diff.result.should have(1).commits # one result for each of the commits
+
+      diff.result.each do |html|
+        html.should_not be_include('@@') # diff correctly processed
+      end
+ 
+      expect(diff.generate_file_link("x/file1.html")).to \
+        eq("<a href='http://example.com/projects/TEST/repos/TESTREPO/browse/x/file1.html?at=a4629e707d80a5769f7a71ca6ed9471015e14dc9'>x/file1.html</a>")
+    end
+  end
+
   describe :lines_are_sequential? do
     before(:all) do
       @diff_to_html = GitCommitNotifier::DiffToHtml.new

data/template/email.html.erb

@@ -6,5 +6,14 @@
 </head>
 <body>
 <%= @html_message %>
+<% if @message_link %>
+<div itemscope itemtype="http://schema.org/EmailMessage">
+  <div itemprop="action" itemscope itemtype="http://schema.org/ViewAction">
+    <link itemprop="url" href="<%= @message_link %>"></link>
+    <meta itemprop="name" content="View Commit"></meta>
+  </div>
+  <meta itemprop="description" content="View this Commit on Website"></meta>
+</div>
+<% end %>
 </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-commit-notifier
 version: !ruby/object:Gem::Version
-  version: 0.12.6
+  version: 0.12.10
 platform: ruby
 authors:
 - Bodo Tasche
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -302,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Sends git commit messages with diffs