blastr 0.0.8 → 0.0.9

data/History.txt

@@ -1,3 +1,7 @@
+== 0.0.9 2009-01-17
+
+* Added usage instructions.
+
 == 0.0.8 2009-01-17
 
 * Bug fix.

data/README.rdoc

@@ -6,7 +6,7 @@
 
 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/PROBLEMS:
+== FEATURES:
 
 Blastr watches for incoming commits to a source repository and voices the commit 
 messages out loud.
@@ -35,6 +35,10 @@ being in the user's PATH.
 
 sudo gem install blastr
 
+== KNOWN PROBLEMS AND GOTCHAS:
+
+* Blastr doesn't provide any kind of online help, there's no "--help" option, etc.
+
 == LICENSE:
 
 (The BSD License)

data/bin/blastr

@@ -3,4 +3,8 @@
 require 'rubygems'
 require "#{File.dirname(__FILE__)}/../lib/blastr.rb"
 
-Blastr::Process.new(ARGV).run
+begin
+  Blastr::Process.new(ARGV).run
+rescue Blastr::UsageError => e
+  puts e
+end

data/lib/blastr.rb

@@ -6,14 +6,44 @@ module Blastr
   require 'tts/tts.rb'
   require 'people/people.rb'
 
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
+  
+  class UsageError < ArgumentError
+    
+    USAGE_TEXT = <<EOS
+
+    Usage: blastr URL [revision]
+    
+    The options are as follows:
+    
+      URL        (required)  The URL identifying the source repository
+                 you want to observe. For Subversion repositories the
+                 URL could be, for example, "http://svn.foo.com/bar" or
+                 "svn://svn.foo.com/bar". For a Git repository, the URL
+                 usually looks like "git://github.com/foo/bar.git".
+                 
+      revision   (optional)  The revision or commit you want to start
+                 observing from. For a Subversion repository, this 
+                 would be a number (e.g. 123 or 5000). For Git, the
+                 revision would be the commit SHA hash - something that
+                 looks like "4d1863552c03bc1ff9c9376b9a24b04daabc67e2".
+                 When this option is omitted, Blastr starts observing
+                 from the latest revision onwards.
+
+EOS
+    
+    def initialize
+      super(USAGE_TEXT)
+    end
+  end
 
   class Process
     def initialize(args=[])
-      scm_url = ARGV[0]
+      validate(args)
+      scm_url = args[0]
       @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
+      @since_revision = @scm.as_revision(args[1]) if args.size > 1
+      @since_revision = @scm.latest_revision unless args.size > 1
     end
 
     def run
@@ -29,6 +59,7 @@ module Blastr
       Blastr::TTS.speak("Commit by #{People.full_name_of(commit.author)}: #{commit.comment}")
     end
     
+    private
     def announce_new_commits
       @scm.commits_since(@since_revision.to_s).each do |commit|
         if @since_revision.before?(commit.revision)
@@ -37,6 +68,9 @@ module Blastr
         end
       end
     end
+    def validate(args)
+      raise UsageError.new if args.size == 0 or args.size > 2
+    end
   end
   
   def Blastr::temp_dir

data/lib/people/people.rb

@@ -3,7 +3,20 @@ require 'yaml'
 module Blastr
   class People
     PEOPLE_FILE = File.expand_path("~/.blastr/people")
-    CONFIG_HELP_MESSAGE = ""
+    CONFIG_HELP_MESSAGE = <<EOS
+
+If you'd like Blastr to pronounce committers' real names instead of their
+UNIX names, you can create a YAML configuration file at
+
+    #{PEOPLE_FILE}
+
+The file format is like this:
+
+johndoe: John Doe
+janedoe: Jane Doe
+jimbo: James Ruby
+
+EOS
     
     puts CONFIG_HELP_MESSAGE unless File.file?(PEOPLE_FILE)
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blastr
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Lasse Koskela