git-commit-notifier 0.11.2 → 0.11.3

data/lib/git_commit_notifier/emailer.rb

@@ -2,32 +2,51 @@
 
 require 'premailer'
 
+# Represents email sender.
 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 repo_name ref_name old_rev new_rev].freeze
+  # Default CSS stylesheet file path
+  DEFAULT_STYLESHEET_PATH = File.join(File.dirname(__FILE__), *'../../template/styles.css'.split('/')).freeze
+  # 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
 
+  # Gets config.
+  # @return [Hash] Configuration
+  # @note Helper that represents class method in instance scope.
+  # @see GitCommitNotifier::Emailer.config
   def config
-    @@config
+    GitCommitNotifier::Emailer.config
   end
 
   def initialize(config, options = {})
-    @@config = config || {}
+    GitCommitNotifier::Emailer.config = config || {}
     PARAMETERS.each do |name|
       instance_variable_set("@#{name}".to_sym, options[name.to_sym])
     end
   end
 
   class << self
+    # [Hash] Gets or sets config.
+    attr_accessor :config
+
+    # Resets compiled template.
+    # @note Useful for tests.
+    # @return [NilClass] nil
     def reset_template
       @template = nil
     end
 
+    # Reads template source code from file system.
+    # @return [String] Template source code.
     def template_source
-      template_file = @@config['custom_template'] || TEMPLATE
+      template_file = config['custom_template'] || TEMPLATE
       IO.read(template_file)
     end
 
+    # Gets or reads compiled template.
+    # @return [Object] Compiled template.
+    # @note Erubis used as template engine if present; ERB otherwise.
     def template
       unless @template
         source = template_source
@@ -41,8 +60,30 @@ class GitCommitNotifier::Emailer
       end
       @template
     end
+
+    # Resets CSS stylesheet source.
+    # @note Useful for tests.
+    # @return [NilClass] nil
+    def reset_stylesheet
+      @stylesheet = nil
+    end
+
+    # Reads CSS stylesheet source code.
+    # @return [String] Stylesheet source code.
+    def stylesheet_source
+      stylesheet = config['stylesheet'] || DEFAULT_STYLESHEET_PATH
+      IO.read(stylesheet)
+    end
+
+    # Gets or reads CSS stylesheet.
+    # @return [String] Stylesheet source code.
+    def stylesheet
+      @stylesheet ||= stylesheet_source
+    end
   end
 
+  # Gets HTML-formatted message.
+  # @return [String] HTML-formatted message.
   def mail_html_message
     html = GitCommitNotifier::Emailer.template.result(binding)
     if config['expand_css'].nil? || config['expand_css']
@@ -52,6 +93,16 @@ class GitCommitNotifier::Emailer
     html
   end
 
+  # Gets stylesheet string.
+  # @note This is helper to provide data from class context.
+  # @see GitCommitNotifier::Emailer.stylesheet
+  # @return [String] Stylesheet source code.
+  def stylesheet_string
+    GitCommitNotifier::Emailer.stylesheet
+  end
+
+  # Gets or creates email part boundary
+  # @return [String] Email part boundary.
   def boundary
     return @boundary if @boundary
     srand
@@ -59,17 +110,17 @@ class GitCommitNotifier::Emailer
     @boundary = Digest::SHA1.hexdigest(seed)
   end
 
-  def stylesheet_string
-    stylesheet = config['stylesheet'] || DEFAULT_STYLESHEET_PATH
-    IO.read(stylesheet)
-  end
-
+  # Performs email delivery in debug mode (to STDOUT).
+  # @return [NilClass] nil
   def perform_delivery_debug(content)
     content.each do |line|
       puts line
     end
+    nil
   end
 
+  # Performs email delivery through SMTP.
+  # @return [NilClass] nil
   def perform_delivery_smtp(content, smtp_settings)
     settings = { }
     %w(address port domain user_name password authentication enable_tls).each do |key|
@@ -94,8 +145,11 @@ class GitCommitNotifier::Emailer
         end
       end
     end
+    nil
   end
 
+  # Performs email delivery through Sendmail.
+  # @return [NilClass] nil
   def perform_delivery_sendmail(content, options = nil)
     sendmail_settings = {
       'location' => "/usr/sbin/sendmail",
@@ -108,28 +162,38 @@ class GitCommitNotifier::Emailer
       end
       f.flush
     end
+    nil
   end
 
+  # Performs email delivery through NNTP.
+  # @return [NilClass] nil
   def perform_delivery_nntp(content, nntp_settings)
     require 'nntp'
     Net::NNTP.start(nntp_settings['address'], nntp_settings['port']) do |nntp|
         nntp.post content
     end
+    nil
   end
 
+  # Creates email message and sends it using configured delivery method.
+  # @return [NilClass] nil
   def send
     to_tag = config['delivery_method'] == 'nntp' ? 'Newsgroups' : 'To'
     quoted_from_alias = !@from_alias.nil? ? quote_if_necessary("#{@from_alias}",'utf-8') : nil
     from = (@from_alias.nil? || @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 = []
-    content << "From: #{from}" if !from.nil?
+    content << "From: #{from}"  unless from.nil?
+
+    # Setting the email date from the commit date is undesired by those
+    # who sort their email by send date instead of receive date
+    #content << "Date: #{@date}" if !@date.nil?
 
     content.concat [
         "#{to_tag}: #{quote_if_necessary(@recipient, 'utf-8')}",
@@ -168,10 +232,11 @@ class GitCommitNotifier::Emailer
     else # sendmail
       perform_delivery_sendmail(content, config['sendmail_options'])
     end
+    nil
   end
 
   # Convert a message into quoted printable encoding,
-  # limiting line length to 76 characters per spec
+  # 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,
@@ -180,7 +245,7 @@ class GitCommitNotifier::Emailer
     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
 
@@ -239,3 +304,5 @@ class GitCommitNotifier::Emailer
   end
 end
 
+
+

data/lib/git_commit_notifier/escape_helper.rb

@@ -1,7 +1,12 @@
-# -*- coding: utf-8; mode: ruby; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- vim:fenc=utf-8:filetype=ruby:et:sw=2:ts=2:sts=2
+# -*- coding: utf-8; mode: ruby; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2
+# -*- vim:fenc=utf-8:filetype=ruby:et:sw=2:ts=2:sts=2
 
+# Provides content escaping helpers.
 module GitCommitNotifier::EscapeHelper
-		
+  # Expand tabs into spaces.
+  # @param [String] s Text to be expanded.
+  # @param [FixNum] tabWidth One tab indentation (in count of spaces).
+  # @return [String] Expanded text.
   def expand_tabs(s, tabWidth)
     delta = 0
     s.gsub(/\t/) do |m|
@@ -11,6 +16,10 @@ module GitCommitNotifier::EscapeHelper
     end
   end
 
+  # Escapes expanded content using CGI.escapeHTML and {#expand_tabs}.
+  # @param [String] s Text to be expanded and extended.
+  # @return [String] Escaped and expanded text.
+  # @see #expand_tabs
   def escape_content(s)
     CGI.escapeHTML(expand_tabs(s, 4)).gsub(" ", " ")
   end

data/lib/git_commit_notifier/executor.rb

@@ -21,7 +21,7 @@ module GitCommitNotifier
           GitCommitNotifier::CommitHook.show_error("No data given on standard input")
           return
         end
-        
+
         # Note that there may be multiple lines on stdin, such
         # as in the case of multiple tags being pushed
         $stdin.each_line do |line|

data/lib/git_commit_notifier/git.rb

@@ -5,17 +5,28 @@ require 'set'
 # Git methods
 class GitCommitNotifier::Git
   class << self
-    # Runs specified command.
+    # Runs specified command and gets its output.
     # @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?
+      raise ArgumentError.new("#{cmd} failed")  unless $?.exitstatus.zero?
       r.force_encoding(Encoding::UTF_8) if r.respond_to?(:force_encoding)
       r
     end
 
-    # runs `git show`
+    # Runs specified command and gets its output as array of lines.
+    # @return (Enumerable(String)) Shell command STDOUT (forced to UTF-8) as enumerable lines.
+    # @raise [ArgumentError] when command exits with nonzero status.
+    # @see from_shell
+    def lines_from_shell(cmd)
+      lines = from_shell(cmd)
+      # Ruby 1.9 tweak.
+      lines = lines.lines  if lines.respond_to?(:lines)
+      lines
+    end
+
+    # Runs `git show`
     # @note uses "--pretty=fuller" option.
     # @return [String] Its output
     # @see from_shell
@@ -23,34 +34,30 @@ class GitCommitNotifier::Git
     # @param [Hash] opts Options
     # @option opts [Boolean] :ignore_whitespaces Ignore whitespaces or not
     def show(rev, opts = {})
-      gitopt = ""
+      gitopt = " --date=rfc2822"
       gitopt += " --pretty=fuller"
       gitopt += " -w" if opts[:ignore_whitespaces]
-      data = from_shell("git show #{rev.strip}#{gitopt}")
-      data
+      from_shell("git show #{rev.strip}#{gitopt}")
     end
 
-    # runs `git log`
+    # 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
+      from_shell("git log --pretty=fuller #{rev1}..#{rev2}").strip
     end
 
-    # runs `git log` and extract filenames only
+    # Runs `git log` and extract filenames only
     # @note uses "--pretty=fuller" and "--name-status" options.
     # @return [Array(String)] File names
-    # @see from_shell
+    # @see lines_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")
-      lines = lines.lines if lines.respond_to?(:lines)
+      lines = lines_from_shell("git log #{rev1}..#{rev2} --name-status --pretty=oneline")
       lines = lines.select {|line| line =~ /^\w{1}\s+\w+/} # grep out only filenames
       lines.uniq
     end
@@ -59,18 +66,16 @@ class GitCommitNotifier::Git
       args = branch_heads - [ branch_head(treeish) ]
       args.map! { |tree| "^#{tree}" }
       args << treeish
-      lines = from_shell("git rev-list #{args.join(' ')}")
-      lines = lines.lines if lines.respond_to?(:lines)
+      lines = lines_from_shell("git rev-list #{args.join(' ')}")
       lines.to_a.map { |commit| commit.chomp }
     end
 
     def branch_heads
-      lines = from_shell("git rev-parse --branches")
-      lines = lines.lines if lines.respond_to?(:lines)
+      lines = lines_from_shell("git rev-parse --branches")
       lines.to_a.map { |head| head.chomp }
     end
 
-    def git_dir()
+    def git_dir
       from_shell("git rev-parse --git-dir").strip
     end
 
@@ -81,37 +86,36 @@ class GitCommitNotifier::Git
     def branch_head(treeish)
       from_shell("git rev-parse #{treeish}").strip
     end
-    
+
     def new_commits(oldrev, newrev, refname, unique_to_current_branch)
       # We want to get the set of commits (^B1 ^B2 ... ^oldrev newrev)
       # Where B1, B2, ..., are any other branch
-
       s = Set.new
-      
+
       # If we want to include only those commits that are
       # unique to this branch, then exclude commits that occur on
       # other branches
       if unique_to_current_branch
         # Make a set of all branches, not'd (^BCURRENT ^B1 ^B2...)
-        not_branches = from_shell("git rev-parse --not --branches")
-        s.merge(not_branches.lines.map {|l| l.chomp}.to_set)
-      
+        not_branches = lines_from_shell("git rev-parse --not --branches")
+        s.merge(not_branches.to_a.map { |l| l.chomp }.to_set)
+
         # Remove the current branch (^BCURRENT) from the set
         current_branch = rev_parse(refname)
         s.delete("^#{current_branch}")
       end
-      
+
       # Add not'd oldrev (^oldrev)
-      s.add("^#{oldrev}") unless oldrev =~ /^0+$/
+      s.add("^#{oldrev}")  unless oldrev =~ /^0+$/
 
       # Add newrev
       s.add(newrev)
-      
+
       # We should now have ^B1... ^oldrev newrev
 
       # Get all the commits that match that specification
-      lines = from_shell("git rev-list #{s.to_a.join(' ')}")
-      commits = lines.lines.map {|l| l.chomp}
+      lines = lines_from_shell("git rev-list --reverse #{s.to_a.join(' ')}")
+      commits = lines.to_a.map { |l| l.chomp }
     end
 
     def rev_type(rev)
@@ -119,7 +123,7 @@ class GitCommitNotifier::Git
     rescue ArgumentError
       nil
     end
-    
+
     def tag_info(refname)
       fields = [
         ':tagobject => %(*objectname)',
@@ -134,16 +138,23 @@ class GitCommitNotifier::Git
       eval(hash_script)
     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 (except '.git' suffix if exists).
+    # @return [String] Human readable repository name.
     def repo_name
       git_prefix = begin
         from_shell("git config hooks.emailprefix").strip
       rescue ArgumentError
         ''
       end
-      return git_prefix unless git_prefix.empty?
+      return git_prefix  unless git_prefix.empty?
       File.expand_path(git_dir).split("/").last.sub(/\.git$/, '')
     end
 
+    # Gets mailing list address.
+    # @note mailing list address retrieved through `git config hooks.mailinglist` call.
+    # @return [String] Mailing list address if exists; otherwise nil.
     def mailing_list_address
       from_shell("git config hooks.mailinglist").strip
     rescue ArgumentError

data/lib/git_commit_notifier/result_processor.rb

@@ -4,19 +4,21 @@ require 'cgi'
 require 'git_commit_notifier/escape_helper'
 
 module GitCommitNotifier
+  # Processes diff result
+  # input (loaded in @diff) is an array having Hash elements:
+  # { :action => action, :token => string }
+  # action can be :discard_a, :discard_b or :match
+  # output: two formatted html strings, one for the removals and one for the additions
   class ResultProcessor
     include EscapeHelper
-    # input (loaded in @diff) is an array having Hash elements:
-    # { :action => action, :token => string }
-    # action can be :discard_a, :discard_b or :match
-
-    # output: two formatted html strings, one for the removals and one for the additions
 
     def results
       close_tags # close last tag
       [array_of_lines(@result[:removal]), array_of_lines(@result[:addition])]
     end
 
+    # Gets length of tokenized diff in characters.
+    # @return [FixNum] Length of the tokenized diff in characters.
     def length_in_chars(diff)
       diff.inject(0) do |length, s|
         token = s[:token]

data/spec/lib/git_commit_notifier/commit_hook_spec.rb

@@ -74,7 +74,7 @@ describe GitCommitNotifier::CommitHook do
   def expect_repository_access
     mock(GitCommitNotifier::Git).rev_type(REVISIONS.first) { "commit" }
     mock(GitCommitNotifier::Git).rev_type(REVISIONS.last) { "commit" }
-    mock(GitCommitNotifier::Git).new_commits(anything, anything, anything, anything) { REVISIONS }    
+    mock(GitCommitNotifier::Git).new_commits(anything, anything, anything, anything) { REVISIONS }
     mock(GitCommitNotifier::Git).mailing_list_address { 'recipient@test.com' }
     mock(GitCommitNotifier::Git).repo_name { 'testproject' }
     mock(GitCommitNotifier::Git).changed_files('7e4f6b4', '4f13525') { [] }