subtrigger 0.2.7 → 0.3.0

data/lib/subtrigger/email.rb

@@ -1,56 +0,0 @@
-module Subtrigger
-  # = E-mail notifications
-  #
-  # Sometimes you want to send notification e-mails after the hook has fired
-  # to inform developers or yourself of some event. This class is a simple
-  # wrapper around the standard +sendmail+ program.
-  #
-  # == Usage example
-  #
-  #   Email.new(:to => 'john@cleese.com',
-  #             :from => 'eric@idle.com',
-  #             :subject => 'Fired',
-  #             :body => 'Your post-commit hook has just fired').send
-  #
-  # If +sendmail+ can not be found on your system an exception will be raised.
-  class Email
-    attr_accessor :from, :to, :subject, :body, :development
-    attr_reader :sendmail
-
-    # Sets up a new message and tries to find +sendmail+ on your system.
-    def initialize(options = {})
-      @to          = options[:to]
-      @from        = options[:from]
-      @subject     = options[:subject]
-      @body        = options[:body]
-      @development = options[:development] || false
-      @sendmail    = Subtrigger.sendmail || `which sendmail`.strip
-      raise 'Could not find sendmail; aborting.' if @sendmail.nil?
-    end
-
-    # Tries to use +sendmail+ to send the message.
-    # The message sent is returned for inspecting purposes.
-    def send
-      message = header + "\n" + body
-      unless development
-        fd = open("|#{sendmail} #{to}", "w")
-        fd.print(message)
-        fd.close
-      end
-      message
-    end
-
-  private
-
-    def header
-      <<-EOS
-To: #{@to}
-From: #{@from}
-Subject: [svn] #{@subject}
-MIME-version: 1.0
-Content-Type: text/plain; charset=UTF-8
-Content-Transfer-Encoding: 8bit
-EOS
-    end
-  end
-end

data/lib/subtrigger/repository.rb

@@ -1,140 +0,0 @@
-module Subtrigger
-  # = Subversion repostitory wrapper
-  #
-  # Use this class to get to the information for a specific commit in a
-  # specific subversion repository. This is a simple wrapper around the
-  # +svnlook+ command.
-  #
-  # This class will look for +svn+ and +svnlook+ on your system and will raise
-  # an exception when it can not be found.
-  #
-  # == Usage example
-  #
-  #   repo = Repository.new('/path/to/repo', 5540)
-  #   repo.author  # => 'Graham'
-  #   repo.message # => 'Added copyright information to the readme'
-  #   repo.changed_projects do |p|
-  #     puts p     # => a changed directory above a trunk, branches or tags
-  #   end
-  #
-  class Repository
-    attr_reader :path, :revision
-
-    # Initialize a new wrapper around a repository at a given revision.
-    #
-    # This will try to find the +svn+ executable on your system and raise
-    # an exception when it cannot be found.
-    #
-    # Exceptions will also be raised when the repository path can not be
-    # found or the revision is not numeric.
-    def initialize(path, revision)
-      raise "Repository '#{path}' not found" unless File.directory?(path)
-      raise "Invalid revision number '#{revision}'" unless revision.to_i > 0
-      @path = path
-      @revision = revision.to_i
-      @svn_path = Subtrigger.svn || `which svn`.strip
-      raise 'Could not locate svn' if @svn_path.nil?
-    end
-
-    # Return the path to the current repository. If given an extra string,
-    # that will be appended to the path.
-    #
-    # Example:
-    #
-    #   repo.path          # => '/path/to/repo'
-    #   repo.path('mydir') # => '/path/to/repo/mydir'
-    #
-    def path(subpath = nil)
-      return File.join(@path, subpath) unless subpath.nil?
-      @path
-    end
-
-    # Returns the information from <tt>svnlook changed</tt>.
-    def changed
-      @changed ||= look_at('changed')
-    end
-
-    # Yields all directories above a changed trunk, branches or tags directory.
-    #
-    # Assuming a project layout like this:
-    #
-    #   [root]
-    #   |- project1
-    #   |- project2
-    #   |- group1
-    #     `- project3
-    #       |- branches
-    #       |- tags
-    #       `- trunk
-    #
-    # Then committing to <tt>group1/project3/trunk</tt> will yield both
-    # <tt>group1/project3/trunk</tt> and <tt>project3</tt>.
-    #
-    # The list of changed project names is returned as an array.
-    def changed_projects #:yields: full_path, project_path
-      projects = []
-      (@dirs_changed ||= look_at('dirs-changed')).split("\n").each do |dir|
-        if dir =~ /([\w\-\.]+)\/(trunk|branches|tags)/
-          project_name = $1
-          top_level_dir = case dir
-          when /^(.*\/trunk)/: $1
-          when /^(.*\/(?:tags|branches)\/[\w\-]+)/: $1
-          end
-          projects << project_name
-          yield top_level_dir, project_name if block_given?
-        end
-      end
-      projects
-    end
-
-    # Returns the HEAD revision number (<tt>svnlook youngest</tt>)
-    def head
-      @head ||= look_at('youngest')
-    end
-
-    # Returns the author of the last commit.
-    def author
-      @author ||= get_line_from_info(0)
-    end
-
-    # Returns the log message of the last commit.
-    def message
-      @message ||= get_line_from_info(3)
-    end
-
-    # Returns the date from the last commit.
-    def date
-      @date ||= get_line_from_info(1)
-    end
-
-    # Runs an arbitrary +svn+ command and returns its results.
-    def exec(command)
-      command = "#{@svn_path} #{command} #{Subtrigger.svn_args}"
-      `#{command}`
-    end
-
-  private
-
-    # Execute a +svnlook+ command for the current repository and revision.
-    def look_at(subcommand)
-      `#{File.join(File.dirname(@svn_path), 'svnlook')} #{subcommand} #{@path} -r #{@revision}`
-    end
-
-    # Get the contents of a line from the <tt>svnlook info</tt> output, which
-    # looks like this:
-    #
-    #   Author name
-    #   Commit date
-    #   Log message length
-    #   Log message
-    #
-    # Note that the log messages might have multiple lines. Asking for line 3
-    # (actually 4, counting from 0) will give you that line and all lines
-    # after that.
-    def get_line_from_info(n)
-      @info ||= look_at('info')
-      parts = @info.split("\n")
-      n = n >= 3 ? parts[3..parts.size].join("\n") : parts[n]
-    end
-  end
-end

data/lib/subtrigger/trigger.rb

@@ -1,60 +0,0 @@
-module Subtrigger
-  # = Call blocks on a matching pattern
-  #
-  # This is a framework for combining pairs of matchers and callbacks to run
-  # on a commit message. You can define a trigger which this class will
-  # apply to a log message.
-  #
-  # == Example usage
-  #
-  #   Trigger.define(/foo/) do |matches, repo|
-  #     puts "Someone used 'foo' in his commit message"
-  #   end
-  #
-  # When the above trigger is defined and somebody makes a commit message
-  # containing +foo+ the block will be called. +matches+ contains any
-  # captured regular expression groups, +repo+ is a +Repository+ object for
-  # the current repository revision.
-  #
-  # You can define as many triggers as you like. When no triggers are found
-  # an exception will be raised. When no trigger applies, it will quit
-  # silently.
-  class Trigger
-    class << self
-      @triggers = {}
-
-      # Run all available triggers on the given Repository object.
-      def run(repo)
-        raise 'No suitable triggers found.' if @triggers.nil?
-        @triggers.each_pair do |pattern, block|
-          new(pattern, repo, &block)
-        end
-      end
-
-      def triggers
-        @triggers ||= {}
-      end
-
-      def reset
-        @triggers = {}
-      end
-
-      # Create a new Trigger object and add it to the stack.
-      def define(pattern, &block)
-        (@triggers ||= {})[pattern] = block;
-      end
-    end
-
-    def initialize(pattern, repo, &block)
-      @pattern, @repo, @callback = pattern, repo, block
-      parse
-    end
-
-  private
-
-    # Scan the commit message and fire the callback if it matches.
-    def parse
-      @repo.message.scan(@pattern) { |match| @callback.call(match, @repo) }
-    end
-  end
-end

data/test/helper.rb

@@ -1,11 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'subtrigger'
-
-class Test::Unit::TestCase
-end

data/test/test_email.rb

@@ -1,44 +0,0 @@
-require 'helper'
-
-class TestEmail < Test::Unit::TestCase
-  context 'with attributes' do
-    setup do
-      @email = Subtrigger::Email.new(
-        :to => 'to@to.com',
-        :from => 'from@from.com',
-        :subject => 'subject',
-        :body => 'body',
-        :development => true
-      )
-      @message = @email.send
-    end
-
-    should 'use custom sendmail location' do
-      Subtrigger.sendmail = 'foo'
-      assert_equal('foo', Subtrigger::Email.new.sendmail)
-    end
-
-    should 'set all e-mail attributes' do
-      assert_equal('from@from.com', @email.from)
-      assert_equal('to@to.com', @email.to)
-      assert_equal('subject', @email.subject)
-      assert_equal('body', @email.body)
-    end
-
-    should 'use to address' do
-      assert_match(/From: from@from.com/, @message)
-    end
-
-    should 'use from address' do
-      assert_match(/To: to@to.com/, @message)
-    end
-
-    should 'use subject' do
-      assert_match(/Subject: \[svn\] subject/, @message)
-    end
-
-    should 'use message body' do
-      assert_match(/body/, @message)
-    end
-  end
-end

data/test/test_repository.rb

@@ -1,75 +0,0 @@
-require 'helper'
-
-class TestRepository < Test::Unit::TestCase
-  should 'not work on non-existant repo' do
-    assert_raise(RuntimeError) { Subtrigger::Repository.new('foo', 'bar') }
-  end
-
-  context 'for a repository' do
-    setup do
-      File.stubs(:directory?).returns(true)
-      @r = Subtrigger::Repository.new('path/to/repo', 1)
-    end
-
-    should 'not work on illegal revision' do
-      assert_raise(RuntimeError) { Subtrigger::Repository.new('foo', 'bar') }
-    end
-
-    should 'expand path' do
-      assert_equal('path/to/repo/foo', @r.path('foo'))
-    end
-
-    should 'read all lines of message from info' do
-      @r.expects(:look_at).with('info').returns("Arjan\ndate\n100\nFoo\nBar\nBaz")
-      assert_equal("Foo\nBar\nBaz", @r.message)
-    end
-
-    should 'use svnlook info' do
-      @r.expects(:look_at).with('info').returns('Foo')
-      assert_equal('Foo', @r.author)
-    end
-
-    should 'use custom configuration' do
-      Subtrigger::Repository.any_instance.expects(:`).with('/usr/foo/svn info --non-interactive').once
-      Subtrigger::Repository.any_instance.expects(:`).with('/usr/foo/svnlook info path/to/repo -r 1').once.returns('')
-      Subtrigger.svn = '/usr/foo/svn'
-      Subtrigger.svn_args = '--non-interactive'
-      @r = Subtrigger::Repository.new('path/to/repo', 1)
-      @r.exec('info')
-      @r.author
-    end
-
-    should 'return changed project names' do
-      lines = <<-EOS
-www.project1.com/trunk
-www.project2.com/branches/FB-feature
-sub/www.project2.com/tags/v1
-sub/www.project2.com/tags/v1/test
-EOS
-      @r.expects(:look_at).with('dirs-changed').returns(lines)
-      assert_equal(['www.project1.com', 'www.project2.com', 'www.project2.com', 'www.project2.com'], @r.changed_projects)
-    end
-
-    should 'yield changed directories' do
-      lines = <<-EOS
-www.project1.com/trunk
-www.project2.com/branches/FB-feature
-sub/www.project2.com/tags/v1
-sub/www.project2.com/tags/v1/test
-EOS
-      @r.expects(:look_at).with('dirs-changed').returns(lines)
-      yieldings = [
-        ['www.project1.com/trunk', 'www.project1.com'],
-        ['www.project2.com/branches/FB-feature', 'www.project2.com'],
-        ['sub/www.project2.com/tags/v1', 'www.project2.com'],
-        ['sub/www.project2.com/tags/v1', 'www.project2.com']
-      ]
-      i = 0
-      @r.changed_projects do |path, project|
-        assert_equal(yieldings[i][0], path)
-        assert_equal(yieldings[i][1], project)
-        i += 1
-      end
-    end
-  end
-end

data/test/test_subtrigger.rb

@@ -1,44 +0,0 @@
-require 'helper'
-
-class TestSubtrigger < Test::Unit::TestCase
-  context 'with a clean slate' do
-    setup do
-      Subtrigger.reset
-      Subtrigger::Trigger.reset
-    end
-
-    should 'output the version number' do
-      assert_match(/\d+\.\d+\.\d+/, Subtrigger.version)
-    end
-
-    should 'configure with a block' do
-      assert_nil Subtrigger.svn
-      output = Subtrigger.configure do |c|
-        c.svn = 'foo'
-      end
-      assert_equal('foo', Subtrigger.svn)
-      assert_equal(Subtrigger, output)
-    end
-
-    should 'Create new Repository object' do
-      Subtrigger::Repository.expects(:new).with('foo', '1')
-      Subtrigger.run('foo', '1')
-    end
-
-    should 'Run all triggers' do
-      Subtrigger::Repository.stubs(:new).returns('foo')
-      Subtrigger::Trigger.expects(:run).with('foo')
-      Subtrigger.run('foo', '1')
-    end
-
-    should 'create a new trigger' do
-      assert_equal(0, Subtrigger::Trigger.triggers.size)
-      Subtrigger.on(/foo/) { |m,r| }
-      assert_equal(1, Subtrigger::Trigger.triggers.size)
-    end
-
-    should 'chain creation of triggers' do
-      assert_equal(Subtrigger, Subtrigger.on(/foo/) { |m,r| })
-    end
-  end
-end

data/test/test_trigger.rb

@@ -1,37 +0,0 @@
-require 'helper'
-
-class TestTrigger < Test::Unit::TestCase
-  context 'in a clean state' do
-    setup do
-      Subtrigger::Trigger.reset
-    end
-
-    should 'define a new trigger' do
-      Subtrigger::Trigger.define(/foo/) { |m, r| raise 'bar' }
-      assert_equal(1, Subtrigger::Trigger.triggers.size)
-    end
-
-    should 'apply all triggers' do
-      i = 0
-      Subtrigger::Trigger.define(/foo/) { |m,r| i += 1 }
-      Subtrigger::Trigger.define(/o+/) { |m,r| i += 1 }
-      Subtrigger::Trigger.run(stub(:message => 'foo bar'))
-      assert_equal(2, i)
-    end
-
-    should 'ignore unmatching triggers' do
-      i = 0
-      Subtrigger::Trigger.define(/foo/) { |m,r| i += 1 }
-      Subtrigger::Trigger.define(/x+/) { |m,r| i += 1 }
-      Subtrigger::Trigger.run(stub(:message => 'foo bar'))
-      assert_equal(1, i)
-    end
-
-    should 'empty list of triggers' do
-      Subtrigger::Trigger.define(/foo/) { |m,r| }
-      assert_equal(1, Subtrigger::Trigger.triggers.size)
-      Subtrigger::Trigger.reset
-      assert_equal(0, Subtrigger::Trigger.triggers.size)
-    end
-  end
-end