blastr 0.0.6 → 0.0.7

data/History.txt

@@ -1,3 +1,7 @@
+== 0.0.7 2009-01-17
+
+* Structural refactorings, isolating the SCM stuff better from the core.
+
 == 0.0.6 2009-01-17
 
 * Code cleanup

data/Manifest.txt

@@ -5,6 +5,7 @@ README.rdoc
 Rakefile
 bin/blastr
 lib/blastr.rb
+lib/people/people.rb
 lib/scm/git.rb
 lib/scm/scm.rb
 lib/scm/svn.rb
@@ -12,5 +13,8 @@ lib/tts/tts.rb
 script/console
 script/destroy
 script/generate
+test/test_git_log_entry.rb
+test/test_git_revision.rb
 test/test_helper.rb
+test/test_svn_revision.rb
 test/test_tts.rb

data/README.rdoc

@@ -8,7 +8,16 @@ Blastr observes a version control repository for commits and makes audible annou
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+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)
+
+The supported operating systems (for running Blastr) include:
+   * Mac OS X
+   * Linux (requires the 'espeak' or 'festival' text-to-speech utility)
 
 == SYNOPSIS:
 

data/lib/blastr.rb

@@ -1,52 +1,40 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'yaml'
-require 'scm/git.rb'
-require 'scm/svn.rb'
-require 'tts/tts.rb'
-
 module Blastr
-  VERSION = '0.0.6'
-  
-  class Author
-    PEOPLE_FILE = File.expand_path("~/.blastr/people")
-    def self.people
-      if File.file?(PEOPLE_FILE)
-        yaml = YAML.load_file(PEOPLE_FILE)
-        return yaml unless yaml == false
-      end
-      { }
-    end
+  require 'scm/scm.rb'
+  require 'tts/tts.rb'
+  require 'people/people.rb'
+
+  VERSION = '0.0.7'
 
-    def self.full_name_of(username)
-      people[username] ||= username
-    end
-  end
-  
   class Process
     def initialize(args=[])
       scm_url = ARGV[0]
-      @scm = Blastr.scm(scm_url)
+      @scm = Blastr::SourceControl.implementation_for(scm_url)
       @since_revision = @scm.as_revision(ARGV[1]) if ARGV.size > 1
       @since_revision = @scm.latest_revision unless ARGV.size > 1
     end
 
+    def run
+      puts "Polling #{@scm.name} commits since revision #{@since_revision}..."
+      while true
+        announce_new_commits
+        sleep 30
+      end
+    end
+    
     def announce(commit)
       puts "[#{commit.revision}] Commit by #{commit.author}: #{commit.comment}"
-      Blastr::TTS.speak("Commit by #{Author.full_name_of(commit.author)}: #{commit.comment}")
+      Blastr::TTS.speak("Commit by #{People.full_name_of(commit.author)}: #{commit.comment}")
     end
     
-    def run
-      puts "Polling #{@scm.name} commits since revision #{@since_revision}..."
-      while true
-        @scm.commits_since(@since_revision.to_s).each do |commit|
-          if @since_revision.before?(commit.revision)
-            announce(commit)
-            @since_revision = commit.revision
-          end
+    def announce_new_commits
+      @scm.commits_since(@since_revision.to_s).each do |commit|
+        if @since_revision.before?(commit.revision)
+          announce(commit)
+          @since_revision = commit.revision
         end
-        sleep 30
       end
     end
   end
@@ -58,16 +46,4 @@ module Blastr
     temp_dir
   end
 
-  def Blastr::scm_implementations
-    [ Blastr::Subversion, Blastr::Git ]
-  end
-
-  def Blastr::scm(url)
-    scm_implementations.each do |impl|
-      if impl.understands_url?(url)
-        return impl.new(url)
-      end
-    end
-    raise "No SCM implementation found that would understand #{url}"
-  end
 end

data/lib/people/people.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+module Blastr
+  class People
+    PEOPLE_FILE = File.expand_path("~/.blastr/people")
+    CONFIG_HELP_MESSAGE = ""
+    
+    puts CONFIG_HELP_MESSAGE unless File.file?(PEOPLE_FILE)
+    
+    def self.people
+      if File.file?(PEOPLE_FILE)
+        yaml = YAML.load_file(PEOPLE_FILE)
+        return yaml unless yaml == false
+      end
+      { }
+    end
+
+    def self.full_name_of(username)
+      people[username] ||= username
+    end
+  end
+end

data/lib/scm/git.rb

@@ -2,8 +2,8 @@ require 'rubygems'
 require 'git'
 require 'blastr/scm.rb'
 
-module Blastr
-  
+module Blastr::SourceControl
+    
   class GitLogEntry < LogEntry
     def initialize(commit)
       @revision = GitRevision.new(commit.sha, commit.date)
@@ -15,7 +15,7 @@ module Blastr
   class GitRevision
     attr_accessor :name, :date
     
-    def initialize(name, date = nil)
+    def initialize(name, date = Time.now)
       @name = name
       @date = date
     end
@@ -45,13 +45,13 @@ module Blastr
 
     def as_revision(arg)
       raise "Invalid revision: #{arg}" unless arg =~ /^(HEAD(~\d+)?)|([\d\w:-]+)$/
-      GitRevision.new(arg.to_s)
+      obj = nil
+      with_clone do |clone|
+        obj = clone.object(arg.to_s)
+      end
+      GitRevision.new(obj.sha, obj.date)
     end
   
-    def understands_url?(url)
-      url.index("git://") == 0
-    end
-    
     def latest_revision
       commits = commits_since(as_revision("HEAD~5"))
       return as_revision("HEAD") unless commits.size > 0
@@ -59,19 +59,25 @@ module Blastr
     end
 
     def commits_since(revision)
-      @clone = ::Git.clone(@git_url, Blastr::temp_dir)
-      begin
-        @clone.chdir do
-          commits = []
-          @clone.log.between(revision.to_s).each do |commit|
-            commits << GitLogEntry.new(commit)
-          end
-          return commits.reverse
+      with_clone do |clone|
+        commits = []
+        clone.log.between(revision.to_s).each do |commit|
+          commits << GitLogEntry.new(commit)
         end
-      ensure
-        FileUtils.remove_dir(@clone.dir, :force => true)
+        return commits.reverse
       end
     end
+    
+    private
+    def with_clone
+      clone = ::Git.clone(@git_url, Blastr::temp_dir)
+      clone.chdir do
+        yield clone
+      end
+      FileUtils.remove_dir(clone.dir, :force => true)
+    end
   end
 
 end
+
+Blastr::SourceControl.register_implementation(Blastr::SourceControl::Git)

data/lib/scm/scm.rb

@@ -1,4 +1,5 @@
-module Blastr
+module Blastr::SourceControl
+  
   class LogEntry
     attr_accessor :revision, :author, :comment
     def initialize(revision, author, comment)
@@ -10,4 +11,23 @@ module Blastr
       "revision #{@revision} by #{@author}: #{@comment}"
     end
   end
-end
+  
+  def self.implementation_for(url)
+    IMPLEMENTATIONS.each do |impl|
+      if impl.understands_url?(url)
+        return impl.new(url)
+      end
+    end
+    raise "No SCM implementation found that would understand #{url}"
+  end
+  
+  IMPLEMENTATIONS = []
+  
+  def self.register_implementation(implementation)
+    IMPLEMENTATIONS << implementation unless IMPLEMENTATIONS.include?(implementation)
+  end
+  
+end
+
+require File.dirname(__FILE__) + '/svn.rb'
+require File.dirname(__FILE__) + '/git.rb'

data/lib/scm/svn.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 require 'blastr/scm.rb'
 
-module Blastr
+module Blastr::SourceControl
   
   class SubversionRevision
     attr_accessor :name
@@ -80,3 +80,5 @@ module Blastr
   end
 
 end
+
+Blastr::SourceControl.register_implementation(Blastr::SourceControl::Subversion)

data/test/test_git_log_entry.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGitLogEntry < Test::Unit::TestCase
+  
+  COMMIT_HASH = "db4ace1c9ba6add9a2b08c153367e2b379f8fb4c"
+  COMMIT_DATE = Time.now
+  COMMIT_AUTHOR = "johndoe"
+  COMMIT_MESSAGE = "o hai"
+  
+  class FakeAuthor
+    def initialize(name); @name = name; end
+    def name; @name; end
+  end
+  
+  class FakeCommit
+    def sha; COMMIT_HASH; end
+    def date; COMMIT_DATE; end
+    def author; FakeAuthor.new(COMMIT_AUTHOR); end
+    def message; COMMIT_MESSAGE; end
+  end
+  
+  def test_initialization
+    entry = Blastr::SourceControl::GitLogEntry.new(FakeCommit.new)
+    assert_equal Blastr::SourceControl::GitRevision, entry.revision.class
+    assert_equal COMMIT_HASH, entry.revision.to_s
+    assert_equal COMMIT_DATE, entry.revision.date
+    assert_equal COMMIT_AUTHOR, entry.author
+    assert_equal COMMIT_MESSAGE, entry.comment
+  end
+end

data/test/test_git_revision.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGitRevision < Test::Unit::TestCase
+  
+  SAMPLE_SHA = "db4ace1c9ba6add9a2b08c153367e2b379f8fb4c"
+  
+  def setup
+    @revision_with_date = Blastr::SourceControl::GitRevision.new(SAMPLE_SHA, Time.now - 100)
+    @revision_without_date = Blastr::SourceControl::GitRevision.new(SAMPLE_SHA)
+  end
+
+  def test_to_s
+    assert @revision_without_date.to_s == SAMPLE_SHA
+    assert @revision_with_date.to_s == SAMPLE_SHA
+  end
+
+  def test_before_comparison_between_dated_revisions
+    later_revision = Blastr::SourceControl::GitRevision.new(SAMPLE_SHA, @revision_with_date.date + 1)
+    assert @revision_with_date.before?(later_revision) == true
+    assert later_revision.before?(@revision_with_date) == false
+  end
+
+  def test_revision_defaults_its_date_to_now
+    assert @revision_with_date.before?(@revision_without_date) == true
+    assert @revision_without_date.before?(@revision_with_date) == false
+  end
+
+  def test_before_comparison_with_HEAD
+    head = Blastr::SourceControl::GitRevision.new("HEAD")
+    [@revision_with_date, @revision_without_date].each do |any_revision|
+      assert any_revision.before?(head) == true
+      assert head.before?(any_revision) == false
+    end
+  end
+end

data/test/test_svn_revision.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blastr
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Lasse Koskela
@@ -62,6 +62,7 @@ files:
 - Rakefile
 - bin/blastr
 - lib/blastr.rb
+- lib/people/people.rb
 - lib/scm/git.rb
 - lib/scm/scm.rb
 - lib/scm/svn.rb
@@ -69,7 +70,10 @@ files:
 - script/console
 - script/destroy
 - script/generate
+- test/test_git_log_entry.rb
+- test/test_git_revision.rb
 - test/test_helper.rb
+- test/test_svn_revision.rb
 - test/test_tts.rb
 has_rdoc: true
 homepage: http://blastr.rubyforge.org
@@ -99,5 +103,8 @@ signing_key:
 specification_version: 2
 summary: Blastr observes a version control repository for commits and makes audible announcements out of the commit messages
 test_files: 
+- test/test_git_log_entry.rb
+- test/test_git_revision.rb
 - test/test_helper.rb
+- test/test_svn_revision.rb
 - test/test_tts.rb