blastr 0.0.9 → 0.0.10

data/History.txt

@@ -1,3 +1,10 @@
+== 0.0.10 2009-01-18
+
+* Added support for Mercurial
+  - The URL for Mercurial repositories needs to be prefixed with "hg:" when
+    invoking Blastr because you can't tell by looking at a URL whether it's
+    a Mercurial repository or a Subversion repository.
+
 == 0.0.9 2009-01-17
 
 * Added usage instructions.

data/Manifest.txt

@@ -4,17 +4,23 @@ PostInstall.txt
 README.rdoc
 Rakefile
 bin/blastr
+config/website.yml
 lib/blastr.rb
 lib/people/people.rb
 lib/scm/git.rb
+lib/scm/hg.rb
 lib/scm/scm.rb
 lib/scm/svn.rb
 lib/tts/tts.rb
 script/console
 script/destroy
 script/generate
+test/test_blastr.rb
 test/test_git_log_entry.rb
 test/test_git_revision.rb
 test/test_helper.rb
+test/test_mercurial_revision.rb
+test/test_scm_url_matching.rb
 test/test_svn_revision.rb
 test/test_tts.rb
+website/index.html

data/README.rdoc

@@ -1,10 +1,8 @@
-= blastr
+= DESCRIPTION:
 
-* http://blastr.rubyforge.org
-
-== DESCRIPTION:
-
-Blastr observes a version control repository for commits and makes audible announcements out of the commit messages. It currently supports Subversion and Git on Linux and OS X, possibly on other UNIX-like operating systems as well.
+Blastr observes a version control repository for commits and makes audible 
+announcements out of the commit messages. It currently supports Subversion 
+and Git on Linux and OS X, possibly on other UNIX-like operating systems as well.
 
 == FEATURES:
 
@@ -12,32 +10,57 @@ Blastr watches for incoming commits to a source repository and voices the commit
 messages out loud.
 
 The supported version control systems include:
-   * Subversion (http://subversion.tigris.org)
-   * Git (http://git-scm.com)
+
+* Subversion[http://subversion.tigris.org]
+* Git[http://git-scm.com]
+* Mercurial[http://www.selenic.com/mercurial]
 
 The supported operating systems (for running Blastr) include:
-   * Mac OS X
-   * Linux (requires the 'espeak' or 'festival' text-to-speech utility)
+
+* Mac OS X
+* Linux (requires the eSpeak[http://espeak.sourceforge.net/] or Festival[http://www.cstr.ed.ac.uk/projects/festival/] text-to-speech utility)
 
 == SYNOPSIS:
 
-sudo gem install blastr
-blastr http://svn.acme.com/foo/trunk
-blastr http://svn.acme.com/foo/trunk
-blastr git://github.com/lkoskela/blastr.git
+Subversion:
+
+  blastr http://svn.acme.com/foo/trunk
+
+  blastr http://svn.acme.com/foo/trunk 123
+
+Git:
+
+  blastr git://github.com/lkoskela/blastr.git
+
+  blastr git://github.com/lkoskela/blastr.git e528509fddd57194f1c497ce6583f6869e8ed62c
+
+Mercurial:
+
+  blastr hg:http://hg.serpentine.com/tutorial/hello
+
+  blastr hg:http://hg.serpentine.com/tutorial/hello 2
 
 == REQUIREMENTS:
 
-Blastr depends on the "git" gem (>= 1.0.5) and the "svn" command line client 
-being in the user's PATH.
+Blastr depends on the git[http://git.rubyforge.org/] gem (>= 1.0.5).
+This dependency should be installed automatically when you install
+Blastr with <tt>gem install blastr</tt>.
+
+Blastr also depends on the standard command line client for the source 
+repository in question being in the user's PATH. For example, in order 
+to observe a Subversion repository the "svn" executable needs to be in 
+PATH. For Git, the "git" executable needs to be in PATH. For Mercurial, 
+"hg" needs to be in PATH.
 
 == INSTALL:
 
-sudo gem install blastr
+  sudo gem install blastr
 
 == KNOWN PROBLEMS AND GOTCHAS:
 
-* Blastr doesn't provide any kind of online help, there's no "--help" option, etc.
+Blastr doesn't treat non-ASCII characters in commit messages too well. 
+In other words, the developers make no promises whatsoever regarding 
+Blastr's behavior when encountering weird Norwegian scribble.
 
 == LICENSE:
 

data/config/website.yml

@@ -0,0 +1,2 @@
+host: lkoskela@rubyforge.org
+remote_dir: /var/www/gforge-projects/blastr

data/lib/blastr.rb

@@ -6,7 +6,7 @@ module Blastr
   require 'tts/tts.rb'
   require 'people/people.rb'
 
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
   
   class UsageError < ArgumentError
     
@@ -38,7 +38,7 @@ EOS
   end
 
   class Process
-    def initialize(args=[])
+    def initialize(args)
       validate(args)
       scm_url = args[0]
       @scm = Blastr::SourceControl.implementation_for(scm_url)
@@ -68,7 +68,7 @@ EOS
         end
       end
     end
-    def validate(args)
+    def validate(args=[])
       raise UsageError.new if args.size == 0 or args.size > 2
     end
   end

data/lib/scm/hg.rb

@@ -0,0 +1,92 @@
+require 'fileutils'
+require File.dirname(__FILE__) + '/scm.rb'
+
+module Blastr::SourceControl
+  
+  class MercurialRevision
+    attr_accessor :name
+    
+    def initialize(name)
+      @name = name
+    end
+    
+    def to_s
+      @name
+    end
+    
+    def before?(revision)
+      return false if @name == "tip"
+      return true if revision.name == "tip"
+      @name.to_i < revision.name.to_i
+    end
+  end
+
+  class Mercurial
+    def name; "Mercurial"; end
+
+    def self.understands_url?(url)
+      url.index("hg:http") == 0
+    end
+
+    def initialize(repo_url)
+      @repo_url = $1 if repo_url =~ /hg:(.*)/
+    end
+
+    def as_revision(arg)
+      raise "Invalid revision: #{arg}" unless arg =~ /^(tip)|([\d\w:-]+)$/
+      MercurialRevision.new(arg)
+    end
+  
+    def latest_revision
+      commits = commits_since(as_revision("tip"))
+      return as_revision("tip") unless commits.size > 0
+      MercurialRevision.new(commits.last.revision.to_s)
+    end
+
+    def commits_since(revision)
+      with_clone do
+        hg_log(revision.to_s)
+      end
+    end
+    
+    private
+    def hg_log(revision = 0)
+      nonascii = /([^a-zA-Z0-9\.,:;\-_\?!"'\s]+?)/u
+      entries = []
+      current_changeset = {}
+      %x[hg log -r #{revision}:].each_line do |line|
+        if line =~ /^changeset:\s+(.+?):(.+?)$/
+          entries << current_changeset unless current_changeset.empty?
+          current_changeset = { :revision => $1, :hash => $2 }
+        elsif line =~ /^user:\s+(.+?)(\s<(.+?)@(.+?)>)?$/
+          current_changeset[:author] = $1
+        elsif line =~ /^summary:\s+(.+?)$/
+          current_changeset[:comment] = $1.strip
+        elsif current_changeset.key? :comment
+          current_changeset[:comment] = "#{current_changeset[:comment]} #{line.strip}"
+        end
+      end
+      entries << current_changeset unless current_changeset.empty?
+      
+      entries.collect do |map|
+        LogEntry.new(as_revision(map[:revision]), map[:author], map[:comment].gsub(nonascii, 'X '))
+      end
+    end
+    
+    def with_clone
+      clone_dir = Blastr::temp_dir
+      %x[hg clone #{@repo_url} #{clone_dir}]
+      current_dir = Dir.pwd
+      Dir.chdir(clone_dir)
+      begin
+        yield
+      ensure
+        Dir.chdir(current_dir)
+        FileUtils.remove_dir(clone_dir, :force => true)
+      end
+    end
+  end
+
+end
+
+Blastr::SourceControl.register_implementation(Blastr::SourceControl::Mercurial)

data/lib/scm/scm.rb

@@ -31,3 +31,4 @@ end
 
 require File.dirname(__FILE__) + '/svn.rb'
 require File.dirname(__FILE__) + '/git.rb'
+require File.dirname(__FILE__) + '/hg.rb'

data/lib/scm/svn.rb

@@ -25,7 +25,7 @@ module Blastr::SourceControl
     def name; "Subversion"; end
     
     def self.understands_url?(url)
-      not url.match(/(https?|svn):\/\/.+/u).nil?
+      not url.match(/^(https?|svn):\/\/.+$/u).nil?
     end
     
     def initialize(svn_url)

data/test/test_blastr.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBlastrProcess < Test::Unit::TestCase
+  def test_command_line_arguments_are_validated
+    assert_raise Blastr::UsageError do
+      Blastr::Process.new([])
+    end
+    assert_raise Blastr::UsageError do
+      Blastr::Process.new(["http://svn.com", "123", "too-much"])
+    end
+    assert_nothing_raised do
+      Blastr::Process.new(["http://svn.com", "123"])
+    end
+  end
+end

data/test/test_mercurial_revision.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMercurialRevision < Test::Unit::TestCase
+
+  def test_to_s
+    rev = Blastr::SourceControl::MercurialRevision.new("123")
+    assert rev.to_s == "123"
+  end
+
+  def test_before_comparison_between_revisions
+    rev123 = Blastr::SourceControl::MercurialRevision.new("123")
+    rev456 = Blastr::SourceControl::MercurialRevision.new("456")
+    assert rev123.before?(rev456) == true
+    assert rev456.before?(rev123) == false
+  end
+
+  def test_before_comparison_with_tip
+    rev = Blastr::SourceControl::MercurialRevision.new("100")
+    tip = Blastr::SourceControl::MercurialRevision.new("tip")
+    assert rev.before?(tip) == true
+    assert tip.before?(rev) == false
+  end
+end

data/test/test_scm_url_matching.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestScmURLMatching < Test::Unit::TestCase
+  GIT_URL = "git://foo.com/bar.git"
+  MERCURIAL_URL = "hg:http://foo.com/svn"
+  SVN_HTTP_URL = "http://foo.com/svn"
+  SVN_HTTPS_URL = "https://foo.com/svn"
+  SVN_NATIVE_URL = "svn://foo.com/svn"
+  SVN_URLS = [ SVN_HTTP_URL, SVN_HTTPS_URL, SVN_NATIVE_URL ]
+  ALL_URLS = [ SVN_URLS, GIT_URL, MERCURIAL_URL ].flatten
+  
+  def test_subversion
+    SVN_URLS.each do |url|
+      assert Blastr::SourceControl::Subversion.understands_url?(url), "#{url} should be a Subversion URL!"
+    end
+    ALL_URLS.reject {|url| SVN_URLS.include?(url) }.each do |url|
+      assert Blastr::SourceControl::Subversion.understands_url?(url) == false, "#{url} should not be a Subversion URL!"
+    end
+  end
+
+  def test_git
+    assert Blastr::SourceControl::Git.understands_url?(GIT_URL)
+    ALL_URLS.reject {|url| url == GIT_URL }.each do |url|
+      assert Blastr::SourceControl::Git.understands_url?(url) == false, "#{url} should not be a Git URL!"
+    end
+  end
+
+  def test_mercurial
+    assert Blastr::SourceControl::Mercurial.understands_url?(MERCURIAL_URL)
+    ALL_URLS.reject {|url| url == MERCURIAL_URL }.each do |url|
+      assert Blastr::SourceControl::Mercurial.understands_url?(url) == false, "#{url} should not be a Mercurial URL!"
+    end
+  end
+end

data/website/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<html>
+	<head>
+		<title>Blastr</title>
+		<meta HTTP-EQUIV="REFRESH" content="0; url=http://blastr.rubyforge.org/rdoc">
+	</head>
+	<body>
+		<p>Redirecting to <a href="rdoc">Blastr documentation</a>...
+	</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blastr
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors: 
 - Lasse Koskela
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-17 00:00:00 +02:00
+date: 2009-01-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: Blastr observes a version control repository for commits and makes audible announcements out of the commit messages. It currently supports Subversion and Git on Linux and OS X, possibly on other UNIX-like operating systems as well.
+description: Blastr observes a version control repository for commits and makes audible  announcements out of the commit messages. It currently supports Subversion  and Git on Linux and OS X, possibly on other UNIX-like operating systems as well.
 email: 
 - lasse.koskela@gmail.com
 executables: 
@@ -61,22 +61,28 @@ files:
 - README.rdoc
 - Rakefile
 - bin/blastr
+- config/website.yml
 - lib/blastr.rb
 - lib/people/people.rb
 - lib/scm/git.rb
+- lib/scm/hg.rb
 - lib/scm/scm.rb
 - lib/scm/svn.rb
 - lib/tts/tts.rb
 - script/console
 - script/destroy
 - script/generate
+- test/test_blastr.rb
 - test/test_git_log_entry.rb
 - test/test_git_revision.rb
 - test/test_helper.rb
+- test/test_mercurial_revision.rb
+- test/test_scm_url_matching.rb
 - test/test_svn_revision.rb
 - test/test_tts.rb
+- website/index.html
 has_rdoc: true
-homepage: http://blastr.rubyforge.org
+homepage: "Blastr observes a version control repository for commits and makes audible "
 post_install_message: 
 rdoc_options: 
 - --main
@@ -101,10 +107,13 @@ rubyforge_project: blastr
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Blastr observes a version control repository for commits and makes audible announcements out of the commit messages
+summary: Blastr observes a version control repository for commits and makes audible  announcements out of the commit messages
 test_files: 
+- test/test_blastr.rb
 - test/test_git_log_entry.rb
 - test/test_git_revision.rb
 - test/test_helper.rb
+- test/test_mercurial_revision.rb
+- test/test_scm_url_matching.rb
 - test/test_svn_revision.rb
 - test/test_tts.rb