git-commit-notifier 0.11.10 → 0.11.11

data/CHANGES.md

@@ -2,10 +2,19 @@
 
 ## Not yet released
 
+## Version 0.11.11
+
+* Allow per branch mailing lists.
+* Support for github option for link_files setting.
+* Added possibility to automatically send a mail to the committer.
+* Allow short_commit_id in subject template
+
+## Version 0.11.10
+
 * Display info message if the config.yml specified is not found.
 * Strip whitespace after splitting emails for SMTP.
 * Added prefer_git_config_mailinglist config variable.
-* Allow to use one configuarion per all cgit projects.
+* Allow to use one configuration file per all cgit projects.
 * Support for Gitalist.
 
 ## Version 0.11.9

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
 
@@ -6,3 +6,5 @@ gem "rcov", :group => :test, :platforms => :mri_18
 gem "erubis", "~> 2.7"
 gem "ripper", :group => :development, :platforms => :mri_18
 
+gem "coveralls", :require => false, :platforms => [:mri_19, :mri_20], :group => :development
+

data/README.md

@@ -1,8 +1,10 @@
 # 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)
+[![build status](https://secure.travis-ci.org/git-commit-notifier/git-commit-notifier.png)](https://travis-ci.org/git-commit-notifier/git-commit-notifier)
+[![Code Climate](https://codeclimate.com/github/git-commit-notifier/git-commit-notifier.png)](https://codeclimate.com/github/git-commit-notifier/git-commit-notifier)
+[![Coverage Status](https://coveralls.io/repos/git-commit-notifier/git-commit-notifier/badge.png?branch=master)](https://coveralls.io/r/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)__
+## Description
 
 This gem sends email commit messages splitting commits that were pushed in one step.
 The Email is delivered as text or HTML with changes refined per word. Emails
@@ -26,6 +28,8 @@ Example email:
 
 ![Example](http://img171.imageshack.us/img171/954/gitcommitnotifieremailpq3.png "Example")
 
+__by Bodo Tasche (bodo 'at' wannawork 'dot' de), Akzhan Abdulin (akzhan 'dot' abdulin 'at' gmail 'dot' com), Csoma Zoltan  (info 'at' railsprogrammer 'dot' net)__
+
 ## Requirements
 
 * Ruby 1.8.7 or higher.

data/VERSION

@@ -1 +1 @@
-0.11.10
+0.11.11

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

@@ -32,6 +32,7 @@ show_summary: true
 #     branch_name           - Name of the git branch
 #     slash_branch_name     - /branch_name (master is "" unless show_master_branch_name)
 #     commit_id             - The git commit id (hash)
+#     short_commit_id       - The abbreviated git commit id (first 7 digits of the hash)
 #     description           - The git description tag ("git describe --always")
 #     message               - The commit message
 #     commit_number         - The commit number within the push; 1-based
@@ -55,6 +56,13 @@ show_summary: true
 # The recipient (or newsgroup for nntp) for the commit
 # It can send to multiple destinations, just separate email addresses by ",".
 mailinglist: developers@example.com,dev2@example.com,dev3@example.com,cto@example.com
+# or setup mailing list per branch
+# mailinglist:
+#   master: developers@example.com,dev2@example.com,dev3@example.com,cto@example.com
+#   default: otherbranches@example.com
+
+# If set to true, the committer (author) will receive the commit mail as well.
+send_mail_to_committer: false
 
 # If set to true, the notifier will check first for a git config hooks.mailinglist
 # variable and use the recipients listed there before checking for the recipient(s)
@@ -115,7 +123,7 @@ nntp_settings:
   port: 119
 
 # Decorate files and commit ids with link to a webview. Possible values: none, gitweb,
-# gitorious, cgit, trac, gitlabhq, gitalist or redmine
+# gitorious, cgit, trac, gitlabhq, gitalist, github or redmine
 link_files: none
 
 # If link_files is set to "gitweb", you need to configure the path to your gitweb
@@ -155,6 +163,12 @@ gitalist:
   path: http://gitalist.example.com
   project: test.git
 
+# If link_files is set to "github", you need to configure the project name of
+# your GitHub account
+github:
+  path: https://github.com
+  project: project-name
+
 # If link_files is set to "redmine", you need to configure the path to your redmine
 # instance
 redmine:

data/lib/git_commit_notifier/commit_hook.rb

@@ -40,6 +40,18 @@ module GitCommitNotifier
         @logger ||= Logger.new(config)
       end
 
+      def email?(email)
+        !!(email =~ /@/)
+      end
+
+      def add_committer_to_recipient(recipient, committer_email)
+        if email?(committer_email) 
+          "#{recipient},#{committer_email}"
+        else
+          recipient
+        end
+      end
+
       # Gets list of branches from {config} to include into notifications.
       # @note All branches will be notified about if returned list is nil; otherwise only specified branches will be notifified about.
       # @return [Array(String), NilClass] Array of branches to include into notifications or nil.
@@ -105,11 +117,14 @@ module GitCommitNotifier
         slash_branch_name = "" if !config["show_master_branch_name"] && slash_branch_name == '/master'
 
         # Identify email recipients
-        if config["prefer_git_config_mailinglist"]
-          recipient = Git.mailing_list_address || config["mailinglist"] 
+        recipient = nil
+        recipient = Git.mailing_list_address  if config["prefer_git_config_mailinglist"]
+        if config["mailinglist"].kind_of?(Hash)
+          recipient ||= config["mailinglist"][branch_name] || config["mailinglist"]["default"]
         else
-          recipient = config["mailinglist"] || Git.mailing_list_address
+          recipient ||= config["mailinglist"]
         end
+        recipient ||= Git.mailing_list_address  unless config["prefer_git_config_mailinglist"]
 
         # If no recipients specified, bail out gracefully. This is not an error, and might be intentional
         if recipient.nil? || recipient.length == 0
@@ -141,6 +156,7 @@ module GitCommitNotifier
         #     branch_name
         #     slash_branch_name
         #     commit_id (hash)
+        #     short_commit_id (first few unique digits of the hash)
         #     description ('git describe' tag)
         #     short_message
         #     commit_number
@@ -153,6 +169,7 @@ module GitCommitNotifier
           :branch_name => branch_name,
           :slash_branch_name => slash_branch_name,
           :commit_id => nil,
+          :short_commit_id => lambda { |commit_info| Git.short_commit_id(commit_info[:commit]) },
           :description => lambda { |commit_info| Git.describe(commit_info[:commit]) },
           :message => nil,
           :commit_number => nil,
@@ -192,7 +209,7 @@ module GitCommitNotifier
 
           emailer = Emailer.new(config,
             :project_path => project_path,
-            :recipient => recipient,
+            :recipient => config["send_mail_to_committer"] ? add_committer_to_recipient(recipient, result[:commit_info][:email]) : recipient,
             :from_address => config["from"] || result[:commit_info][:email],
             :from_alias => result[:commit_info][:author],
             :reply_to_address => config["reply_to_author"] ? result[:commit_info][:email] : config["from"] || result[:commit_info][:email],
@@ -239,7 +256,7 @@ module GitCommitNotifier
 
             emailer = Emailer.new(config,
               :project_path => project_path,
-              :recipient => recipient,
+              :recipient => config["send_mail_to_committer"] ? add_committer_to_recipient(recipient, result[:commit_info][:email]) : recipient,
               :from_address => config["from"] || result[:commit_info][:email],
               :from_alias => result[:commit_info][:author],
               :reply_to_address => config["reply_to_author"] ? result[:commit_info][:email] : config["from"] || result[:commit_info][:email],

data/lib/git_commit_notifier/diff_to_html.rb

@@ -211,6 +211,8 @@ module GitCommitNotifier
           end
         elsif config["link_files"] == "gitalist" && config["gitalist"]
           "<a href='#{config['gitalist']['path']}/#{config['gitalist']['project'] || Git.repo_name}/#{@current_commit}/blob/#{file_name}'>#{file_name}</a>"
+        elsif config["link_files"] == "github" && config["github"]
+          "<a href='#{config['github']['path']}/#{config['github']['project']}/#{Git.repo_name}/blob/#{@current_commit}/#{file_name}'>#{file_name}</a>"
         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
@@ -510,6 +512,7 @@ module GitCommitNotifier
       :gitlabhq  => lambda { |config, commit| "<a href='#{config['gitlabhq']['path']}/#{Git.repo_name.gsub(".", "_")}/commits/#{commit}'>#{commit}</a>" },
       :gitalist  => lambda { |config, commit| "<a href='#{config['gitalist']['path']}/projects/#{config['gitalist']['project'] || Git.repo_name}/#{commit}/log'>#{commit}</a>" },
       :redmine   => lambda { |config, commit| "<a href='#{config['redmine']['path']}/projects/#{config['redmine']['project'] || Git.repo_name}/repository/revisions/#{commit}'>#{commit}</a>" },
+      :github    => lambda { |config, commit| "<a href='#{config['github']['path']}/#{config['github']['project']}/#{Git.repo_name}/commit/#{commit}'>#{commit}</a>" },
       :default   => lambda { |config, commit| commit.to_s }
     }.freeze
 

data/lib/git_commit_notifier/git.rb

@@ -107,6 +107,10 @@ class GitCommitNotifier::Git
       from_shell("git rev-parse '#{param}'").strip
     end
 
+    def short_commit_id(param)
+      from_shell("git rev-parse --short '#{param}'").strip
+    end
+
     def branch_head(treeish)
       from_shell("git rev-parse #{treeish}").strip
     end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ end
 if RUBY_VERSION >= '1.9'
   Encoding.default_external = "utf-8"
   Encoding.default_internal = "utf-8"
+
+  require 'coveralls'
+  Coveralls.wear!
 end
 
 require 'rubygems'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-commit-notifier
 version: !ruby/object:Gem::Version
-  version: 0.11.10
+  version: 0.11.11
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -339,7 +339,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -83889522611154396
+      hash: 778864539407809625
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: