ruby_git_hooks 0.0.31

data/lib/ruby_git_hooks/case_clash.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "ruby_git_hooks"
+
+# This hook checks whether a similar file exists with the same name
+# except for uppercase/lowercase.  It's useful when Mac OS and Unix
+# people need to coexist in a single Git repository.  You can be sure
+# that the Linux people can't check in files that the Mac people can
+# neither see nor delete.
+
+class CaseClashHook < RubyGitHooks::Hook
+  def check
+    downcase_hash = {}
+
+    ls_files.map(&:strip).each do |filename|
+      downcase_hash[filename.downcase] ||= []
+      downcase_hash[filename.downcase].push filename
+    end
+
+    okay = true
+    downcase_hash.each do |_, filenames|
+      if filenames.length > 1
+        okay = false
+        STDERR.puts "Duplicate-except-case files detected: #{filenames.inspect}"
+      end
+    end
+
+    okay
+  end
+end

data/lib/ruby_git_hooks/copyright_check.rb

@@ -0,0 +1,181 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "ruby_git_hooks"
+
+# This hook checks whether a proper copyright notice exists at the top
+# of each of your files.  Right now it hardcodes most of the Copyright
+# notice format, though you can customize the company name.  If you'd
+# prefer a more flexible format, we accept pull requests!
+
+class CopyrightCheckHook < RubyGitHooks::Hook
+  COPYRIGHT_REGEXP = /Copyright\s+\(C\)\s*(?<pre_year>.*)-?(?<cur_year>\d{4})\s+(?<company>.+)/i
+
+  # Only check files with known checkable extensions
+  EXTENSIONS = [
+                "c", "cpp", "cc", "cp",
+                "h", "hp", "hpp",
+                "m", "mm",
+                "java",
+                "bat",
+                "sh",
+                "ps1",
+                "rb",
+               ]
+
+  OPTIONS = [ "domain", "from", "subject", "via", "via_options", "intro",
+              "no_send", "company_check", "exclude_files" ]
+
+  Hook = RubyGitHooks::Hook
+
+  attr_accessor   :cur_year
+
+  def initialize(options = {})
+    bad_options = options.keys - OPTIONS
+    raise "CopyrightCheckHook created with unrecognized options: " +
+      "#{bad_options.inspect}!" if bad_options.size > 0
+
+    @options = options
+    @options["domain"] ||= "mydomain.com"
+    @options["from"] ||= "Copyright Cop <noreply@#{@options["domain"]}>"
+    @options["subject"] ||= "Copyright Your Files, Please!"
+    @options["via"] ||= "no_send"
+    @options["via_options"] ||= {}
+    @options["exclude_files"]  ||= []   # for generated files, etc.
+    @cur_year = Time.now.strftime("%Y")
+  end
+
+  def check
+    no_notice = []
+    outdated_notice = []
+    outdated_company = []
+
+    cur_year = Time.now.strftime("%Y")
+
+    files_changed.each do |filename|
+      extension = (filename.split(".") || [])[-1]
+      next unless EXTENSIONS.include?(extension)
+      next if file_contents[filename] == ""  # for now this is how we recognize a deleted file.
+      next if @options["exclude_files"].include? filename
+      if file_contents[filename] =~ COPYRIGHT_REGEXP
+        parsed_cur_year = $~["cur_year"]
+        parsed_company = $~["company"]
+
+        unless parsed_cur_year == cur_year
+          outdated_notice << filename
+        end
+
+        # If there is a "company_check" option, either a string
+        # or regexp, make sure that the detected company name
+        # matches it.
+        if @options["company_check"] &&
+            !(parsed_company[@options["company_check"]])
+          outdated_company << filename
+        end
+      else
+        no_notice << filename
+      end
+    end
+
+    bad_num = no_notice.size + outdated_notice.size + outdated_company.size
+    return true if bad_num < 1
+
+    desc = build_description(no_notice, outdated_notice, outdated_company)
+
+    recipients = {}
+    self.commits.each do |commit|
+      author = Hook.shell!("git log -n 1 --pretty=format:\"%aE %aN\" #{commit}")
+      email, name = author.chomp.split(" ", 2)
+      recipients[name] = email
+    end
+
+    STDERR.puts "Warnings for commit from Copyright Check:\n--#{desc}\n--"
+
+    unless @options["no_send"] || @options["via"] == "no_send"
+        require "pony"  # wait until we need it
+                        # NOTE: Pony breaks on Windows so don't use this option in Windows.
+        recipients.each do |name, email|
+          email_str = "#{name} <#{email}>"
+          STDERR.puts "Sending warning email to #{email_str}"
+          ret = Pony.mail :to => email_str,
+                  :from => @options["from"],
+                  :subject => @options["subject"],
+                  :body => desc,
+                  :via => @options["via"],
+                  :via_options => @options["via_options"]
+      end
+    end
+    # Block commit if installed as a pre-commit or pre-receive hook
+    false
+  end
+
+  protected
+
+  def commit_list
+    # return the list of commits to display. We don't want to show them all
+    # (it looks scary when there's a lot)
+
+    # return a list of the shortened SHAH1s for readability
+    # tried listing commit.last..commit.first but that didn't seem right either
+    # problem is really when there's dozens of commits.
+    self.commits.map {|c| c[0..6]}.join(", ")
+  end
+
+
+  def current_repo
+      # which repository are these commits in
+    # Since we are running as a hook, we may get back the .git directory
+
+    full_path = Hook.shell!("git rev-parse --show-toplevel").chomp
+    # like "/path/to/repos/test-repo" or maybe "/path/to/repos/test-repo/.git"
+    # return "test-repo"
+    File.basename full_path.sub(/.git\z/, "")
+  end
+  #
+  # Return an appropriate email based on the set of files with
+  # problems.  If you need a different format, please inherit from
+  # CopyrightCheckHook and override this method.
+  #
+  def build_description(no_notice, outdated_notice, outdated_company)
+
+    description = @options["intro"] || ""
+    description.concat <<DESCRIPTION
+
+In repository: #{current_repo}
+commit(s): #{commit_list}
+
+You have outdated, inaccurate or missing copyright notices.
+
+Specifically:
+=============
+DESCRIPTION
+
+    if outdated_notice.size > 0
+      description.concat <<DESCRIPTION
+The following files do not list #{cur_year} as the most recent copyright year:
+
+  #{outdated_notice.join("\n  ")}
+-----
+DESCRIPTION
+    end
+
+    if outdated_company.size > 0
+      description.concat <<DESCRIPTION
+The following files do not properly list your company as the holder of copyright:
+
+  #{outdated_company.join("\n  ")}
+
+DESCRIPTION
+    end
+
+    if no_notice.size > 0
+      description.concat <<DESCRIPTION
+The following files have no notice or a notice I didn't recognize:
+
+  #{no_notice.join("\n  ")}
+
+DESCRIPTION
+    end
+
+    description
+  end
+end

data/lib/ruby_git_hooks/email_notify.rb

@@ -0,0 +1,50 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "ruby_git_hooks"
+
+# This hook sends out email notification of commits to a configurable
+# list of recipients via the Pony gem, which uses the Ruby Mail gem.
+
+class EmailNotifyHook < RubyGitHooks::Hook
+  LEGAL_OPTIONS = [ "no_send", "via", "via_options", "max_lines", "recipients" ]
+
+  def initialize(options = {})
+    bad_opts = options.keys - LEGAL_OPTIONS
+    unless bad_opts.empty?
+      STDERR.puts "Called EmailNotifyHook with bad options: #{bad_opts.inspect}!"
+      exit 1
+    end
+
+    @options = options
+    @options["max_lines"] ||= 300
+
+    unless @options["recipients"]
+      raise "Must specify at least one recipient to EmailNotifyHook!"
+    end
+  end
+
+  def check
+    content = file_diffs.flat_map { |path, diff| ["", path, diff] }.join("\n")
+    if content.split("\n").size > options["max_lines"]
+      content = "Diffs are too big.  Skipping them.\nFiles:\n" +
+        file_diffs.keys.join("\n")
+    end
+
+    recipients = @options.recipients.split /,|;/
+
+    unless @options["no_send"] || @options["via"] == "no_send"
+      require "pony"
+      
+      recipients.each do |name, email|
+        ret = Pony.mail :to => email,
+                  :from => @options["from"],
+                  :subject => @options["subject"],
+                  :body => desc,
+                  :via => @options["via"],
+                  :via_options => @options["via_options"]
+      end
+    end
+
+    true
+  end
+end

data/lib/ruby_git_hooks/git_ops.rb

@@ -0,0 +1,93 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+# This is a set of Git operations, run via shell.  It permits much
+# cleaner unit tests.  Initially it was written in this way because it
+# was very small and simple.  Now it should be converted to Grit or a
+# similar tool or library.
+
+module RubyGitHooks; end
+
+module RubyGitHooks::GitOps
+  extend self
+
+  Hook = RubyGitHooks::Hook
+
+  def new_bare_repo(name = "parent_repo.git")
+    Hook.shell! "mkdir #{name} && cd #{name} && git init --bare"
+  end
+
+  def clone_repo(parent_name = "parent_repo.git", child_name = "child_repo")
+    Hook.shell! "git clone #{parent_name} #{child_name}"
+  end
+
+  def add_hook(repo_name, hook_name, contents)
+    # We're adding to either a normal or bare directory.
+    # Check for hooks directory.
+    if File.exist? "#{repo_name}/.git/hooks"
+      hooks_dir = "#{repo_name}/.git/hooks"
+    elsif File.exist? "#{repo_name}/hooks"
+      hooks_dir = "#{repo_name}/hooks"
+    else
+      raise "Can't locate hooks directory under #{repo_name.inspect}!"
+    end
+
+    filename = File.join(hooks_dir, hook_name)
+    File.open(filename, "w") do |f|
+      f.write(contents)
+    end
+    Hook.shell!("chmod +x #{filename}")
+  end
+
+  def new_commit(repo_name, filename, contents = "Contents", commit_message = "Single-file commit of #{filename}")
+    if !contents.nil?
+      File.open(File.join(repo_name, filename), "w") do |f|
+        f.write(contents)
+      end
+    end
+
+    Hook.shell! "cd #{repo_name} && git add #{filename} && git commit -m \"#{commit_message}\""
+  end
+
+  def new_single_file_commit(repo_name = "child_repo", contents = "Single-file commit")
+    @single_file_counter ||= 1
+
+    filename = "test_file_#{@single_file_counter}"
+
+    new_commit(repo_name, filename, contents)
+
+    @single_file_counter += 1
+  end
+    system("git mv child_repo/file_to_rename child_repo/renamed_file")
+
+  def git_delete(repo_name="child_repo", filename="file_to_delete")  
+    # filename is a file that has already been added and commited to the repo
+    Hook.shell! "cd #{repo_name} && git rm #{filename}"
+  end
+  
+  def git_rename(repo_name="child_repo", filename="file_to_rename", new_filename)  
+    # filename is a file that has already been added and commited to the repo
+    Hook.shell! "cd #{repo_name} && git mv #{filename} #{new_filename}"
+  end
+
+
+  def last_commit_sha(repo_name = "child_repo")
+    Hook.shell!("cd #{repo_name} && git log -n 1 --format=%H").chomp
+  end
+
+  def git_commit(repo_name = "child_repo", commit_message = "Generic commit message")
+    Hook.shell! "cd #{repo_name} && git commit -m \"#{commit_message}\""
+  end
+
+  def git_push(repo_name = "child_repo", remote = "origin", branch = "master")
+    Hook.shell! "cd #{repo_name} && git push #{remote} #{branch}"
+  end
+
+  def rewind_one_commit(repo_name = "child_repo")
+    Hook.shell! "cd #{repo_name} && git reset --hard HEAD~"
+  end
+
+  def last_commit_message(repo_name = "child_repo")
+    Hook.shell!("cd #{repo_name} && git log -1").chomp
+  end
+
+end